{"swagger":"2.0","info":{"version":"V1","title":"API","x-swagger-net-version":"8.5.28.001"},"host":"api.mintsoft.co.uk","schemes":["https"],"paths":{"/api/Accounting/Invoice/List":{"get":{"tags":["Accounting"],"operationId":"Accounting_ListInvoices","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"ClientId","in":"query","required":false,"type":"integer","format":"int32","default":0},{"name":"PageNo","in":"query","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","required":false,"type":"integer","format":"int32","default":100},{"name":"SinceDate","in":"query","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ConfirmedInvoiceSummary"},"xml":{"name":"ConfirmedInvoiceSummary","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/Invoice/All":{"get":{"tags":["Accounting"],"operationId":"Accounting_GetInvoicesAll","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ConfirmedInvoiceSummary"},"xml":{"name":"ConfirmedInvoiceSummary","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/Invoice/{id}":{"get":{"tags":["Accounting"],"operationId":"Accounting_GetInvoices","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConfirmedInvoiceSummary"}}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/Invoice/{id}/Orders":{"get":{"tags":["Accounting"],"operationId":"Accounting_GetInvoiceOrders","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/InvoiceItem"},"xml":{"name":"InvoiceItem","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/Invoice/Orders/{OrderId}":{"get":{"tags":["Accounting"],"operationId":"Accounting_GetInvoiceItemForOrder","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InvoiceItem"}}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/AddCourierCost":{"post":{"tags":["Accounting"],"summary":"Add Courier Cost to InvoiceItem","description":"Used to add Courier Cost to an InvoiceItem that has failed due to no pricing available","operationId":"Accounting_AddCourierCost","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"request","in":"body","description":"AddCourierCostRequest Json in the Body of the request - Either need to Supply OrderId, OrderNumber and ClientShortName or Tracking Number to locate a unique order","required":true,"schema":{"$ref":"#/definitions/AddCourierCostRequest"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"401":{"description":"Unauthorised request - API key invalid or not in the correct role"},"404":{"description":"Order Cannot be found using the supplied info"}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/Invoice/{id}/Returns":{"get":{"tags":["Accounting"],"operationId":"Accounting_GetInvoiceReturns","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ReturnInvoiceItem"},"xml":{"name":"ReturnInvoiceItem","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/Invoice/{id}/GoodsIn":{"get":{"tags":["Accounting"],"operationId":"Accounting_GetInvoiceGoodsIn","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/GoodsInInvoiceItem"},"xml":{"name":"GoodsInInvoiceItem","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/Invoice/{id}/Collections":{"get":{"tags":["Accounting"],"operationId":"Accounting_GetInvoiceCollections","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/CollectionInvoiceItem"},"xml":{"name":"CollectionInvoiceItem","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/Invoice/{id}/Other":{"get":{"tags":["Accounting"],"operationId":"Accounting_GetInvoiceGenerics","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/GenericInvoiceItem"},"xml":{"name":"GenericInvoiceItem","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Account/Invoice/InvoiceItemTypes":{"get":{"tags":["Accounting"],"summary":"Get additional invoice item types.","operationId":"Accounting_GetInvoiceItemTypes","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/InvoiceItemType"},"xml":{"name":"InvoiceItemType","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Account/Invoice/AddAdditionalInvoiceItem":{"post":{"tags":["Accounting"],"summary":"Add an additional invoice item.","operationId":"Accounting_AddAdditionalInvoiceItem","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"ClientId","in":"query","description":"Client's ID to add additional invoice item to","required":true,"type":"integer","format":"int32"},{"name":"Type","in":"query","description":"Invoice item type","required":true,"type":"string"},{"name":"Amount","in":"query","description":"Cost, or rate * quantity","required":true,"type":"number","format":"double"},{"name":"InvoiceDate","in":"query","description":"Invoice dates to apply additional invoice item: yyyy-MM-dd","required":true,"type":"string","format":"date-time"},{"name":"Comment","in":"query","description":"Optional - Add a comment","required":false,"type":"string","default":""},{"name":"WarehouseId","in":"query","description":"Warehouse ID to add additional invoice item to","required":false,"type":"integer","format":"int32","default":0}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Accounting/LocationTypeStoragePrice":{"post":{"tags":["Accounting"],"summary":"Add a Location Type Storage Price.","operationId":"Accounting_AddLocationTypeStoragePrice","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"request","in":"body","description":"Request body containing Client, ClientId, LocationType, Cost, and Frequency","required":true,"schema":{"$ref":"#/definitions/AddLocationTypeStoragePriceRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Account/Invoice/GetUnconfirmedInvoiceSummary":{"get":{"tags":["Accounting"],"summary":"Get unconfirmed invoice summary.","operationId":"Accounting_GetUnconfirmedInvoiceSummary","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientID","in":"query","description":"Client's ID","required":true,"type":"integer","format":"int32"},{"name":"fromDate","in":"query","description":"From date: yyyy-MM-dd","required":true,"type":"string","format":"date-time"},{"name":"toDate","in":"query","description":"To date: yyyy-MM-dd","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InvoiceSummary"}}},"security":[{"ms-apikey":[]}]}},"/api/Account/Invoice/GetUnconfirmedInvoiceStorageCosts":{"get":{"tags":["Accounting"],"summary":"Get unconfirmed invoice storage costs.","operationId":"Accounting_GetUnconfirmedInvoiceStorageCosts","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientID","in":"query","description":"Client's ID","required":true,"type":"integer","format":"int32"},{"name":"fromDate","in":"query","description":"From date: yyyy-MM-dd","required":true,"type":"string","format":"date-time"},{"name":"toDate","in":"query","description":"To date: yyyy-MM-dd","required":true,"type":"string","format":"date-time"},{"name":"pageNo","in":"query","required":false,"type":"integer","format":"int32","default":1},{"name":"limit","in":"query","required":false,"type":"integer","format":"int32","default":1000}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/StorageInvoiceItem"},"xml":{"name":"StorageInvoiceItem","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/ASN":{"put":{"tags":["ASN"],"summary":"Create new ASN(Advanced Shipping Notice)","description":"Used to Creating a new ASN i.e. Advising of a Delivery into the Warehouse","operationId":"ASN_CreateASN","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"ASN","in":"body","description":"ASN Json in the Body of the request","required":true,"schema":{"$ref":"#/definitions/NewASN"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}":{"get":{"tags":["ASN"],"summary":"Get ASN(Advanced Shipping Notice)","description":"Get back latest details about an Existing ASN","operationId":"ASN_GetASN","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ASN"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"post":{"tags":["ASN"],"summary":"Update ASN Details","description":"Update ASN Details for an Existing ASN","operationId":"ASN_UpdateASN","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"},{"name":"ASN","in":"body","required":true,"schema":{"$ref":"#/definitions/NewASN"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"delete":{"tags":["ASN"],"summary":"Delete ASN","description":"Delete ASN - Cannot be undone","operationId":"ASN_DeleteASN","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/List":{"get":{"tags":["ASN"],"summary":"List Of ASN(Advanced Shipping Notice)","description":"Get a List of ASNs within the system (ASN Items are excluded from this endpoint)","operationId":"ASN_ListASNs","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"ASNStatusId","in":"query","description":"ASNStatusId can be supplied as a list e.g. 1;2;4 if you want to filter multiple statuses","required":false,"type":"string","default":""},{"name":"ClientId","in":"query","description":"ClientId - Filter by ClientId - 3PL Admin Users Only","required":false,"type":"integer","format":"int32","default":0},{"name":"PageNo","in":"query","description":"Page No - Default 1","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","description":"Number of Result to be returned - Default 100 - Max 100","required":false,"type":"integer","format":"int32","default":100},{"name":"WarehouseId","in":"query","description":"Filter by WarehouseId","required":false,"type":"integer","format":"int32","default":0},{"name":"SinceLastUpdated","in":"query","description":"Filter by any ASNs that have been Updated Since supplied Timestamp","required":false,"type":"string","format":"date-time"},{"name":"BookedInStartInterval","in":"query","description":"Filter by any ASNs that have been booked supplied Timestamp","required":false,"type":"string","format":"date-time"},{"name":"BookedInEndInterval","in":"query","description":"Filter by any ASNs that have been booked supplied Timestamp","required":false,"type":"string","format":"date-time"},{"name":"IncludeASNItems","in":"query","description":"Request the ASN items","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/ASN"},"xml":{"name":"ASN","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}/ConnectActions":{"put":{"tags":["ASN"],"summary":"Register ASN Webhook / ASNConnect Action","description":"Can be used to register a Webhook event so that when ASN is booked in a specified URL can be called with details of the book in","operationId":"ASN_UploadConnectAction","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"},{"name":"ConnectAction","in":"body","description":"Connect Action in Body of Result as Json - Type = API, ExtraCode1 = Callback Url,ExtraCode4 = Auth Header Values Complete = false","required":true,"schema":{"$ref":"#/definitions/NewASNConnectAction"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/Statuses":{"get":{"tags":["ASN"],"summary":"Get ASN Statuses","description":"Get a list of Possible ASNStatusIds and Names within the system","operationId":"ASN_GetStatuses","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/ASNStatus"},"xml":{"name":"ASNStatus","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/GoodsInTypes":{"get":{"tags":["ASN"],"summary":"Get Goods In Types","description":"Get a list of Possible GoodsInTypes within the system e.g. Pallet, Container","operationId":"ASN_GetGoodsInTypes","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/EnumPair"},"xml":{"name":"EnumPair","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}/Confirm":{"get":{"tags":["ASN"],"summary":"Confirm ASN","description":"Confirm ASN is now ready to be expected in the warehouse","operationId":"ASN_ConfirmASN","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}/BookIn":{"get":{"tags":["ASN"],"summary":"Book In ASN - Admin Only","description":"Book in Items on ASN and mark as complete","operationId":"ASN_BookInASN","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}/BookInPartial":{"get":{"tags":["ASN"],"summary":"Book In  Partial ASN - Admin Only","description":"Partially book in ASN  - Not all Items have arrived","operationId":"ASN_BookInASNPartial","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}/PartBook":{"get":{"tags":["ASN"],"summary":"Part Book In ASN - Admin Only","description":"Book in Items that have been received already","operationId":"ASN_PartBook","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}/Paperwork":{"get":{"tags":["ASN"],"summary":"Get ASN Paperwork","description":"Get Paperwork relating to ASN","operationId":"ASN_GetPaperwork","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"type":"string"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}/Items/Receive":{"post":{"tags":["ASN"],"summary":"ASN - Receive Items","description":"Receive Items against a ASN","operationId":"ASN_ReceiveItem","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"},{"name":"Items","in":"body","description":"Json list of the Items being receieved in the body of the request","required":true,"schema":{"items":{"$ref":"#/definitions/ASNItemAllocation"},"xml":{"name":"ASNItemAllocation","wrapped":true},"type":"array"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}/MarkAwaitingPutAway":{"get":{"tags":["ASN"],"summary":"Mark ASN as Awiating PutAway - Admin Only","description":"Mark an ASN as Awaiting Put Away. Can be set as Put Away complete to Complete the ASN","operationId":"ASN_MarkAwaitingPutAway","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ASN/{id}/MarkPutAwayComplete":{"get":{"tags":["ASN"],"summary":"Mark ASN as PutAway Complete - Admin Only","description":"Mark an ASN already in AwaitingPutAway, as PutAway complete. This will Complete the ASN.","operationId":"ASN_MarkPutAwayComplete","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the ASN","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"ASN with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Auth":{"post":{"tags":["Auth"],"summary":"Authenticate to get an API Key.","description":"The API key is used for authentication of all other API calls. API keys last 24 hours.\r\nAfter that point you'll start receiving 401 unauthorized responses and will need to\r\nrenew the API key.","operationId":"Auth_Post","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/MintsoftAuthRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"Bad request"},"401":{"description":"Invalid Credentials"},"500":{"description":"Internal Server Error"}}}},"/api/Batch":{"post":{"tags":["Batch"],"summary":"Create Batch","description":"Used for creating a Batch using a List of OrderIDs.","operationId":"Batch_CreateBatch","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Batch","in":"body","required":true,"schema":{"$ref":"#/definitions/NewBatch"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Batch/AssignOrderToUser":{"post":{"tags":["Batch"],"summary":"Assign Order To user","description":"Assigns a single order to a User to pick.","operationId":"Batch_AssignOrderToUser","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderID","in":"query","description":"ID of Order you want to assign.","required":true,"type":"integer","format":"int32"},{"name":"AssignToUser","in":"query","description":"User to assign the Order to.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Batch/AssignBatchToUser":{"post":{"tags":["Batch"],"summary":"Assign Batch To user","description":"Assigns a batch to a User to pick.","operationId":"Batch_AssignBatchToUser","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"BatchID","in":"query","description":"ID of Batch you want to assign.","required":true,"type":"integer","format":"int32"},{"name":"AssignToUser","in":"query","description":"User to assign the Batch to.","required":true,"type":"string"},{"name":"PickingType","in":"query","description":"Picking Type to select.","required":true,"type":"string"},{"name":"PickingPriority","in":"query","description":"Mobile picking priority for the Batch. Allowed values: 0 = P1 - Urgent, 1 = P2 - Normal, 2 = P3 - Low. Defaults to 1 (Normal).","required":false,"type":"integer","format":"int32","default":1,"enum":[0,1,2]},{"name":"SpotCheck","in":"query","description":"Spot check override for the Batch (only applied when Stock Take V2 is enabled). Allowed values: 0 = Use Config Rules, 1 = Spot Check Every Pick - Blind, 2 = Spot Check Every Pick - Open, 3 = Do Not Spot Check. Defaults to 0 (Use Config Rules).","required":false,"type":"integer","format":"int32","default":0,"enum":[0,1,2,3]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Batch/List":{"get":{"tags":["Batch"],"summary":"List Batches","description":"Get a List Of Batches Back","operationId":"Batch_ListBatches","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"CreatedSince","in":"query","description":"Filter batches created on or after this date/time.","required":false,"type":"string","format":"date-time"},{"name":"PickingComplete","in":"query","description":"Filter by picking complete status (true/false).","required":false,"type":"boolean"},{"name":"Tote","in":"query","description":"Filter by assigned tote (broad text search).","required":false,"type":"string"}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/Batch"},"xml":{"name":"Batch","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Batch/{id}":{"get":{"tags":["Batch"],"summary":"Get Batch by ID","description":"Get batch details from ID","operationId":"Batch_GetBatch","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Batch ID","required":true,"type":"integer","format":"int32"},{"name":"includeOrderItems","in":"query","description":"Include Order Items for each Order","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Order"},"xml":{"name":"Order","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Batch/StatusUpdate/{id}":{"put":{"tags":["Batch"],"summary":"Update Batch Status","description":"Updates status of an existing batch","operationId":"Batch_UpdateBatchStatus","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Batch ID","required":true,"type":"integer","format":"int32"},{"name":"OrderStatus","in":"query","description":"Order Status ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Batch/DespatchBatch":{"post":{"tags":["Batch"],"summary":"Despatch a completed Batch","description":"Despatches a batch, as long as all related orders have been picked.","operationId":"Batch_DespatchBatch","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"batchId","in":"query","description":"ID of Batch you want to despatch","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ToolkitResult"},"xml":{"name":"ToolkitResult","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Batch/Templates":{"get":{"tags":["Batch"],"summary":"List available Batch Templates","description":"Returns a list of available Batch Templates (ID and Reference).","operationId":"Batch_Templates","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/BatchTemplate"},"xml":{"name":"BatchTemplate","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Batch/CreateBatchFromTemplate":{"post":{"tags":["Batch"],"summary":"Create Batch from Template","description":"Creates a Batch from the Template specified (Batch preview settings are ignored for this API call).","operationId":"Batch_CreateBatchFromTemplate","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"batchTemplateId","in":"query","description":"Id of Template to create Batch from","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Batch/DeleteBatch":{"delete":{"tags":["Batch"],"summary":"Delete Batch","description":"Deletes a Batch and unassigns Orders (Orders will NOT be deleted).","operationId":"Batch_DeleteBatch","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"batchId","in":"query","description":"Id of Batch to delete","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Client":{"get":{"tags":["Client"],"summary":"Get Clients","description":"Get list of Clients - Available to Admin users only","operationId":"Client_Get","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"pageNo","in":"query","description":"Page Number","required":false,"type":"integer","format":"int32","default":1},{"name":"limit","in":"query","description":"Number per page (max 100)","required":false,"type":"integer","format":"int32","default":100},{"name":"sinceLastUpdated","in":"query","description":"Updated Since","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Client"},"xml":{"name":"Client","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"401":{"description":"Invalid UserName or Password or not Admin User"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"post":{"tags":["Client"],"summary":"Create Client","description":"Creates a new Client with General, Customs Information, Picking Costs, Storage Costs, and Goods In Costs fields - Available to Admin users only","operationId":"Client_CreateClient","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Client","in":"body","description":"Client data grouped into General, Customs Information, Picking Costs, Storage Costs, and Goods In Costs sections","required":true,"schema":{"$ref":"#/definitions/CreateClient"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Invalid UserName or Password or not Admin User"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Client/UpdateClient":{"post":{"tags":["Client"],"summary":"Update Client","description":"Updates Client with General, Customs Information, Picking Costs, Storage Costs, and Goods In Costs fields - Available to Admin users only","operationId":"Client_UpdateClient","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Client","in":"body","description":"Client data grouped into General, Customs Information, Picking Costs, Storage Costs, and Goods In Costs sections","required":true,"schema":{"$ref":"#/definitions/UpdateClient"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"401":{"description":"Invalid UserName or Password or not Admin User"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Client/SubClients":{"get":{"tags":["Client"],"summary":"Get a list of SubClients","description":"Get list of SubClients - Available to MasterClient users only","operationId":"Client_SubClients","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/SubClient"},"xml":{"name":"SubClient","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]},"post":{"tags":["Client"],"summary":"Add SubClient","description":"Adds a New SubClient - Available to MasterClient users only","operationId":"Client_AddSubClient","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Client","in":"body","required":true,"schema":{"$ref":"#/definitions/AddSubClient"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Courier/Services":{"get":{"tags":["Courier"],"operationId":"Courier_GetCourierServices","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/CourierService"},"xml":{"name":"CourierService","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Courier/Services/{id}":{"get":{"tags":["Courier"],"operationId":"Courier_GetCourierService","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CourierService"}}},"security":[{"ms-apikey":[]}]}},"/api/Courier/ServiceTypes":{"get":{"tags":["Courier"],"operationId":"Courier_GetCourierServiceTypes","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/CourierServiceType"},"xml":{"name":"CourierServiceType","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Courier/Services/{id}/ExternalNames":{"get":{"tags":["Courier"],"operationId":"Courier_GetExternalCourierServiceNames","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ExternalCourierServiceName"},"xml":{"name":"ExternalCourierServiceName","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/Statuses":{"get":{"tags":["Order"],"operationId":"Order_GetOrderStatuses","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderStatus"},"xml":{"name":"OrderStatus","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/Documents/DocumentTypes":{"get":{"tags":["Order"],"operationId":"Order_GetOrderDocumentTypes","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderDocumentType"},"xml":{"name":"OrderDocumentType","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/Documents/PaperSizes":{"get":{"tags":["Order"],"operationId":"Order_GetOrderDocumentPaperSizes","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/EnumPair"},"xml":{"name":"EnumPair","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/Shipments/TrackingEvents/Statuses":{"get":{"tags":["Order"],"summary":"Tracking Event - Statuses","description":"A List of all the possible Tracking Event Statuses","operationId":"Order_GetOrderShipmentTrackingEventsStatuses","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/EnumPair"},"xml":{"name":"EnumPair","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/Shipments/TrackingEvents/List":{"get":{"tags":["Order"],"summary":"Shipment Tracking Events - List","description":"List Shipment Tracking Events","operationId":"Order_ListTrackingEvents","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"PageNo","in":"query","description":"Page No - Default 1","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","description":"Number of Results to Return - Default 500 - Max 500","required":false,"type":"integer","format":"int32","default":500},{"name":"TrackingStatusId","in":"query","description":"Filter by TrackingStatusId","required":false,"type":"integer","format":"int32","default":0},{"name":"SinceLastUpdated","in":"query","description":"Tracking Events that have happened Since Supplied Time","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/OrderShipmentTrackingEvent"},"xml":{"name":"OrderShipmentTrackingEvent","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order":{"put":{"tags":["Order"],"summary":"Create a New Order","description":"Creates a new order in the system. Optionally include Tags as a comma-separated string to add tags during order creation. Optionally include ConnectAction to create an awaiting action for the order.","operationId":"Order_CreateOrder","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Order","in":"body","required":true,"schema":{"$ref":"#/definitions/NewOrderWithItems"}}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/NewOrderResult"},"xml":{"name":"NewOrderResult","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}":{"get":{"tags":["Order"],"operationId":"Order_Get","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Order"}}},"security":[{"ms-apikey":[]}]},"post":{"tags":["Order"],"summary":"Update Order Details","description":"Update Order Details for an Existing Order - Note Will not Update Order Items use speicified methods for them","operationId":"Order_UpdateOrder","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"Order","in":"body","required":true,"schema":{"$ref":"#/definitions/NewOrder"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/Search":{"get":{"tags":["Order"],"summary":"","operationId":"Order_SearchOrder","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderNumber","in":"query","required":true,"type":"string"},{"name":"exactMatch","in":"query","required":false,"type":"boolean","default":false},{"name":"includeOrderItems","in":"query","description":"Only supported when exactMatch is also == true.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Order"},"xml":{"name":"Order","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/GetOrderId":{"get":{"tags":["Order"],"summary":"Get Order ID by Order Number (Exact Match)","operationId":"Order_GetOrderId","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderNumber","in":"query","description":"Order Number to look up (exact match)","required":true,"type":"string"},{"name":"warehouseId","in":"query","description":"Optional Warehouse ID to filter by","required":false,"type":"integer","format":"int32"},{"name":"clientId","in":"query","description":"Optional Client ID to filter by","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Order found","schema":{"type":"object"}},"400":{"description":"Invalid WarehouseId or ClientId"},"404":{"description":"Order not found or not accessible"}},"security":[{"ms-apikey":[]}]}},"/api/Order/TrackingNumberSearch":{"get":{"tags":["Order"],"summary":"Search Order by Tracking Number (Exact Match)","operationId":"Order_TrackingNumberSearch","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"TrackingNumber","in":"query","description":"Tracking Number to search for (exact match)","required":true,"type":"string"},{"name":"includeOrderItems","in":"query","description":"Include Order Items in the response","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Order"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/Channels":{"get":{"tags":["Order"],"operationId":"Order_GetChannels","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Channel"},"xml":{"name":"Channel","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/List":{"get":{"tags":["Order"],"operationId":"Order_ListOrders","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderStatusId","in":"query","required":false,"type":"integer","format":"int32","default":0},{"name":"ClientId","in":"query","required":false,"type":"integer","format":"int32","default":0},{"name":"ChannelId","in":"query","required":false,"type":"integer","format":"int32","default":0},{"name":"CourierServiceId","in":"query","required":false,"type":"integer","format":"int32","default":0},{"name":"WarehouseId","in":"query","required":false,"type":"integer","format":"int32","default":0},{"name":"PageNo","in":"query","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","required":false,"type":"integer","format":"int32","default":100},{"name":"SinceDate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"SinceLastUpdated","in":"query","required":false,"type":"string","format":"date-time"},{"name":"SinceDespatchDate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"ToDate","in":"query","required":false,"type":"string","format":"date-time"},{"name":"ExcludeTags","in":"query","required":false,"type":"string"},{"name":"IncludeTags","in":"query","required":false,"type":"string"},{"name":"IncludeOrderItems","in":"query","required":false,"type":"boolean","default":false},{"name":"showB2BOnly","in":"query","required":false,"type":"boolean","default":false},{"name":"SortOldestFirst","in":"query","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Order"},"xml":{"name":"Order","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Items":{"get":{"tags":["Order"],"summary":"Get Order Items","description":"Get All of the Items for an Order","operationId":"Order_Items","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderItem"},"xml":{"name":"OrderItem","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]},"put":{"tags":["Order"],"summary":"Add new item to the existing order","description":"Add new Order Item - Can be used for adding an new Item","operationId":"Order_AddOrderItem","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"},{"name":"OrderItem","in":"body","required":true,"schema":{"$ref":"#/definitions/NewOrderItem"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Items/{ItemId}":{"post":{"tags":["Order"],"summary":"Update Order Item","description":"Update Order Item - Can be used for editing the quantity of an Item","operationId":"Order_UpdateOrderItem","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"},{"name":"ItemId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"OrderItem","in":"body","required":true,"schema":{"$ref":"#/definitions/NewOrderItem"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]},"delete":{"tags":["Order"],"summary":"Delete Order Item","description":"Delete Order Item","operationId":"Order_DeleteOrderItem","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"},{"name":"ItemId","in":"path","description":"OrderItemId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Cancel":{"get":{"tags":["Order"],"operationId":"Order_CancelOrder","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/CancelNoStock":{"get":{"tags":["Order"],"description":"Cancel an Order as No Stock","operationId":"Order_CancelOrderNoStock","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkDespatched":{"get":{"tags":["Order"],"summary":"MarkDespatched","description":"Marks an Order as Despatched","operationId":"Order_MarkDespatched","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"},{"name":"TrackingNumber","in":"query","description":"TrackingNumber","required":false,"type":"string","default":""}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkPrinted":{"get":{"tags":["Order"],"summary":"MarkPrinted","description":"Marks an Order as Printed","operationId":"Order_MarkPrinted","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"},{"name":"Comment","in":"query","description":"Comment","required":false,"type":"string","default":""}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/UpdateNumberOfParcels":{"get":{"tags":["Order"],"summary":"Update Number Of Parcels","description":"Updates Number Of Parcels on an Order","operationId":"Order_UpdateNumberOfParcels","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"},{"name":"NumberOfParcels","in":"query","description":"NumberOfParcels","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkAwaitingPayment":{"get":{"tags":["Order"],"summary":"MarkAwaitingPayment","description":"Mark an Order as Awaiting Payment - Moves it to a AwaitingPayment Status","operationId":"Order_MarkAwaitingPayment","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkPaymentReceived":{"get":{"tags":["Order"],"summary":"MarkPaymentReceived","description":"Mark an Order as Payment Received Payment - Moves it to an Order from AwaitingPayment Status so it can be processed","operationId":"Order_MarkPaymentReceived","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkAwaitingConfirmation":{"get":{"tags":["Order"],"summary":"MarkAwaitingConfirmation","description":"Mark an Order as Awaiting Confirmation - Moves it to a AwaitingConfirmation Status","operationId":"Order_MarkAwaitingConfirmation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkConfirmed":{"get":{"tags":["Order"],"summary":"MarkConfirmed","description":"Mark an Order as Confirmed - Moves it to an Order from AwaitingConfirmation Status so it can be processed","operationId":"Order_MarkConfirmed","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkPackAndHold":{"get":{"tags":["Order"],"summary":"MarkPackAndHold","description":"Mark an Order as Pack And Hold- Moves it to an Order To PackAndHold Status to be released for despatch at a future date","operationId":"Order_MarkPackAndHold","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"},{"name":"ReleaseDate","in":"query","description":"Date you want the order released","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkReleasePackAndHold":{"get":{"tags":["Order"],"summary":"MarkReleasePackAndHold","description":"Release an Order as Pack And Hold - Moves it to an Order to it's orginal status","operationId":"Order_MarkReleasePackAndHold","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/DespatchNote":{"get":{"tags":["Order"],"operationId":"Order_DespatchNote","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Comments":{"get":{"tags":["Order"],"operationId":"Order_Comments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderComment"},"xml":{"name":"OrderComment","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]},"post":{"tags":["Order"],"operationId":"Order_AddOrderComment","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"Comment","in":"body","required":true,"schema":{"$ref":"#/definitions/NewOrderComment"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Splits":{"get":{"tags":["Order"],"operationId":"Order_OrderSplit","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderSplit"},"xml":{"name":"OrderSplit","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Documents":{"get":{"tags":["Order"],"operationId":"Order_Documents","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderDocument"},"xml":{"name":"OrderDocument","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]},"put":{"tags":["Order"],"operationId":"Order_UploadOrderDocument","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"OrderDocument","in":"body","required":true,"schema":{"$ref":"#/definitions/NewOrderDocument"}},{"name":"PrintWithOrder","in":"query","required":true,"type":"boolean"},{"name":"DocumentTypeId","in":"query","required":true,"type":"integer","format":"int32"},{"name":"PaperSize","in":"query","required":false,"type":"integer","format":"int32","default":1,"enum":[0,1,2,3,4]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Documents/{DocumentId}/Data":{"get":{"tags":["Order"],"operationId":"Order_GetDocumentData","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"DocumentId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Documents/{DocumentId}":{"get":{"tags":["Order"],"operationId":"Order_GetDocument","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"DocumentId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OrderDocument"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/BoxPackingList":{"get":{"tags":["Order"],"operationId":"Order_GetBoxPackingList","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BoxPackingListResponse"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Documents/{DocumentId}/MarkPrinted":{"get":{"tags":["Order"],"operationId":"Order_MarkDocumentAsPrinted","consumes":[],"produces":[],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"DocumentId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"No Content"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Tag":{"put":{"tags":["Order"],"operationId":"Order_AddOrderTag","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"Tag","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]},"delete":{"tags":["Order"],"operationId":"Order_DeleteOrderTag","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"Tag","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Shipments":{"get":{"tags":["Order"],"operationId":"Order_GetOrderShipment","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderShipment"},"xml":{"name":"OrderShipment","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]},"put":{"tags":["Order"],"operationId":"Order_UploadOrderShipment","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"OrderShipment","in":"body","required":true,"schema":{"$ref":"#/definitions/NewOrderShipment"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Shipments/{OrderShipmentId}":{"delete":{"tags":["Order"],"operationId":"Order_DeleteOrderShipment","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"OrderShipmentId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Shipments/CreateShipment":{"post":{"tags":["Order"],"summary":"Create Shipment - using Courier API Connection","description":"Create a Courier Shipment using the Courier API Connection. Will make an API request to the assigned courier relating to the order.","operationId":"Order_CreateShipment","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"},{"name":"CourierServiceId","in":"query","description":"Optional - CourierServiceId if you want to update CourierService before creating a shipment","required":false,"type":"integer","format":"int32","default":0},{"name":"NumberOfParcels","in":"query","description":"Optional - NumberOfParcels if you want to update NumberOfParcels field before creating a shipment","required":false,"type":"integer","format":"int32","default":0}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ShipmentResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Shipments/CancelShipment":{"delete":{"tags":["Order"],"summary":"Cancel Shipment - using Courier API Connection","description":"Cancel a Courier Shipment using the Courier API Connection. Where supported.","operationId":"Order_CancelShipment","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/ConnectActions":{"get":{"tags":["Order"],"operationId":"Order_GetConnectAction","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderAwaitingAction"},"xml":{"name":"OrderAwaitingAction","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]},"put":{"tags":["Order"],"operationId":"Order_UploadConnectAction","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"OrderShipment","in":"body","required":true,"schema":{"$ref":"#/definitions/NewOrderConnectAction"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Allocations":{"get":{"tags":["Order"],"summary":"Order Allocations","description":"Get a list of the Stock Allocated to an Order including Batch and BB Details","operationId":"Order_Allocations","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/ProductInLocation"},"xml":{"name":"ProductInLocation","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/BarcodeVerifiedOrderItems":{"get":{"tags":["Order"],"summary":"Order Barcode Verifications","description":"Get a list of Barcode Scanning including Batch and Serial Details","operationId":"Order_BarcodeVerifiedOrderItems","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/BarcodeVerifiedOrderItem"},"xml":{"name":"BarcodeVerifiedOrderItem","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Queries":{"get":{"tags":["Order"],"operationId":"Order_Queries","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderQuery"},"xml":{"name":"OrderQuery","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/Queries/{QueryId}/Comments":{"get":{"tags":["Order"],"operationId":"Order_QueryComments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"QueryId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderQueryComment"},"xml":{"name":"OrderQueryComment","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/SplitOrderItems":{"post":{"tags":["Order"],"summary":"SplitOrderItems","description":"Split given OrderItems from existing order onto a new Order that could be despatched seperately.","operationId":"Order_SplitOrderItems","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"},{"name":"OrderItemsToSplit","in":"body","description":"Order Items to Split onto new order","required":true,"schema":{"items":{"$ref":"#/definitions/SplitOrderOnOrderItems"},"xml":{"name":"SplitOrderOnOrderItems","wrapped":true},"type":"array"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/BillingAddress":{"get":{"tags":["Order"],"summary":"Get Billing Address for Order","description":"Returns the Billing Address for an OrderID if one is present.","operationId":"Order_BillingAddress","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"OrderId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/Address"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkFraudRisk":{"post":{"tags":["Order"],"summary":"Marks Fraud Risk","description":"Marks an order as Fraud","operationId":"Order_MarkFraudRisk","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Order Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Order/{id}/MarkFraudRiskAccepted":{"post":{"tags":["Order"],"summary":"Marks Fraud Risk Accepted","description":"Marks an order as Fraud Accepted","operationId":"Order_MarkFraudRiskAccepted","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Order Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/OrderRules":{"get":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_GetOrderRules","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"clientId","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/OrderRule"},"xml":{"name":"OrderRule","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"put":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_UpdateOrderRule","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"orderRule","in":"body","required":true,"schema":{"$ref":"#/definitions/OrderRule"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"post":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_AddOrderRule","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"orderRule","in":"body","required":true,"schema":{"$ref":"#/definitions/OrderRule"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/OrderRules/{id}":{"delete":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_DeleteOrderRule","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/OrderRules/{id}/Activate":{"post":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_MarkOrderRuleActive","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/OrderRules/{id}/Deactivate":{"post":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_MarkOrderRuleInactive","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/OrderRules/{orderRuleId}/Conditions":{"post":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_AddOrderRuleCondition","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"orderRuleId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/AddOrderRuleConditionRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/OrderRules/Conditions/{id}":{"delete":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_DeleteOrderRuleCondition","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/OrderRules/Actions":{"get":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_GetOrderRuleActions","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"type":"string"},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/OrderRules/ConditionOptions":{"get":{"tags":["OrderRules"],"summary":"","description":"","operationId":"OrderRules_GetOrderRuleConditionOptions","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OrderRuleConditionOptions"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/OrderRules/Run/{orderId}":{"post":{"tags":["OrderRules"],"summary":"Run Order rules against a specific order. Please note order rules run automatically when an order is created as well.","description":"","operationId":"OrderRules_RunOrderRules","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"orderId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/RunOrderRulesResult"},"xml":{"name":"RunOrderRulesResult","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product":{"put":{"tags":["Product"],"summary":"Create New Product","description":"Create a new Product","operationId":"Product_CreateProduct","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Product","in":"body","description":"Product ID","required":true,"schema":{"$ref":"#/definitions/Product"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NewProductResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"post":{"tags":["Product"],"summary":"Update Product","description":"Updates an Existing Product","operationId":"Product_UpdateProduct","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Product","in":"body","description":"Product","required":true,"schema":{"$ref":"#/definitions/Product"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}":{"get":{"tags":["Product"],"summary":"Get Product","description":"Get Details about Bundle and Items in the Bundle","operationId":"Product_Get","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Product"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"delete":{"tags":["Product"],"summary":"Delete a Product","description":"Deletes a product - Product cannot be associated to other entities such as Order, ASN, Bundles etc","operationId":"Product_DeleteProduct","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"403":{"description":"Don't have access to the Product or Role to delete"},"404":{"description":"Cannot find product with ID"}},"security":[{"ms-apikey":[]}]}},"/api/Product/ProductPrices":{"put":{"tags":["Product"],"summary":"Add or Update Product Prices","description":"Adds new Product Prices (Limit of 1 Concurrent Request per Mintsoft Customer)","operationId":"Product_UpdateProductPrices","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Prices","in":"body","description":"Prices","required":true,"schema":{"items":{"$ref":"#/definitions/NewProductPrice"},"xml":{"name":"NewProductPrice","wrapped":true},"type":"array"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"delete":{"tags":["Product"],"summary":"Delete Product Prices","description":"Deletes an Existing Product Price","operationId":"Product_DeleteProductPrices","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Prices","in":"body","description":"Product Prices","required":true,"schema":{"items":{"$ref":"#/definitions/NewProductPrice"},"xml":{"name":"NewProductPrice","wrapped":true},"type":"array"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/List":{"get":{"tags":["Product"],"summary":"List Products","description":"Get a List Of Products Back","operationId":"Product_ListProducts","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"PageNo","in":"query","description":"Page No - Default 1","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","description":"Number of Results to Return - Default 100 - Max 100","required":false,"type":"integer","format":"int32","default":100},{"name":"ClientId","in":"query","description":"Filter by Client Id - Admin User Only","required":false,"type":"integer","format":"int32","default":0},{"name":"SinceLastUpdated","in":"query","description":"Products that have been updated Since Supplied Time","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/Product"},"xml":{"name":"Product","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/Bundle":{"put":{"tags":["Product"],"summary":"Create New Bundle","description":"Create a new Bundle","operationId":"Product_CreateBundle","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Bundle","in":"body","description":"Bundle","required":true,"schema":{"$ref":"#/definitions/Bundle"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NewProductResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/Bundle":{"get":{"tags":["Product"],"summary":"Get Bundle","description":"Get Details about Bundle and Items in the Bundle","operationId":"Product_GetBundle","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Bundle"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/StockFlow":{"get":{"tags":["Product"],"summary":"Get Stock Flow Records","description":"Get StockFlow Items by SKU, and Date","operationId":"Product_GetStockFlow","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"},{"name":"FromDate","in":"query","description":"From Date e.g. 2011-10-05T22:26:12-04:00","required":true,"type":"string","format":"date-time"},{"name":"ToDate","in":"query","description":"To Date e.g. 2011-10-05T22:26:12-04:00","required":true,"type":"string","format":"date-time"},{"name":"IncludeDetails","in":"query","description":"Include StockFlowDetails","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/StockFlow"},"xml":{"name":"StockFlow","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/Cartons":{"get":{"tags":["Product"],"summary":"Get Cartons","description":"Get Cartons for a ProductID","operationId":"Product_GetCartons","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ProductContainer"},"xml":{"name":"ProductContainer","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"post":{"tags":["Product"],"summary":"Bulk Add Cartons","description":"Add Cartons against a Product","operationId":"Product_BulkAddCartons","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"},{"name":"Cartons","in":"body","description":"Array of Cartons for product","required":true,"schema":{"items":{"$ref":"#/definitions/ProductContainer"},"xml":{"name":"ProductContainer","wrapped":true},"type":"array"}}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ToolkitResult"},"xml":{"name":"ToolkitResult","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/Carton/{cartonId}":{"delete":{"tags":["Product"],"summary":"Delete Carton","description":"Delete Carton against a Product","operationId":"Product_DeleteCarton","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"},{"name":"cartonId","in":"path","description":"ID of Carton to delete","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/AltCodes":{"get":{"tags":["Product"],"summary":"Get Alt Codes","description":"Get Alternative Codes for a ProductID","operationId":"Product_GetAltCodes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ProductAltCode"},"xml":{"name":"ProductAltCode","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"post":{"tags":["Product"],"summary":"Add Alt Code","description":"Add an AltCode against a Product","operationId":"Product_AddAddAlt","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"},{"name":"SKU","in":"query","description":"The Alternative SKU you want to add","required":true,"type":"string"},{"name":"ConnectMappingType","in":"query","description":"The Type e.g. Amazon, Ebay, API etc","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/StockFlow/Filtered":{"get":{"tags":["Product"],"summary":"Get Stock Flow Records - Filtered","description":"Get StockFlow Items by SKU, and Date, WarehouseId, Types etc","operationId":"Product_GetStockFlowFiltered","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"FromDate","in":"query","description":"From Date e.g. 2011-10-05T22:26:12-04:00","required":true,"type":"string","format":"date-time"},{"name":"ToDate","in":"query","description":"To Date e.g. 2011-10-05T22:26:12-04:00","required":true,"type":"string","format":"date-time"},{"name":"id","in":"path","description":"Product ID - Can be 0 if Supplying SKU","required":true,"type":"integer","format":"int32","default":0},{"name":"SKU","in":"query","description":"Product SKU - Optional","required":false,"type":"string","default":""},{"name":"WarehouseId","in":"query","description":"WarehouseId e.g. 3","required":false,"type":"integer","format":"int32","default":0},{"name":"Types","in":"query","description":"Types of Flows to show e.g. ALL,IN, OUT, ALLOCATE, UNALLOCATE,TRANSFER, SCRAP - Multiple can be ; list e.g. IN;OUT","required":false,"type":"string","default":""},{"name":"IncludeOrders","in":"query","description":"Include Flows that relate to Orders","required":false,"type":"boolean","default":true},{"name":"IncludeReturns","in":"query","description":"Include Flows that relate to Returns","required":false,"type":"boolean","default":true},{"name":"IncludeDetails","in":"query","description":"Include StockFlowDetails","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/StockFlow"},"xml":{"name":"StockFlow","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/Inventory":{"get":{"tags":["Product"],"summary":"Get Inventory Records","description":"Get Inventory Records relating to a ProductId","operationId":"Product_GetInventory","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"},{"name":"breakdown","in":"query","description":"Include a Breakdown of that StockHolding by Batch, Serial, BestBefore etc","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/InventoryItem"},"xml":{"name":"InventoryItem","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/Inventory/Bulk":{"get":{"tags":["Product"],"summary":"Get Inventory Records for Multiple Products (Paged)","description":"Get Inventory Records for Multiple Products, paged by Product count","operationId":"Product_GetBulkInventory","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"PageNo","in":"query","description":"Page No - Default 1","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","description":"Number of Products to Return Inventory For - Default 100 - Max 500","required":false,"type":"integer","format":"int32","default":100},{"name":"ClientId","in":"query","description":"Filter by Client Id - Admin User Only","required":false,"type":"integer","format":"int32","default":0},{"name":"WarehouseId","in":"query","description":"Filter by Warehouse Id - Default 0 (All Warehouses)","required":false,"type":"integer","format":"int32","default":0},{"name":"LastUpdatedSince","in":"query","description":"Filter by LastUpdated - Only return inventory records updated since the supplied date/time","required":false,"type":"string","format":"date-time"},{"name":"Breakdown","in":"query","description":"Include a Breakdown of that StockHolding by Batch, Serial, BestBefore etc","required":false,"type":"boolean","default":false},{"name":"SKU","in":"query","description":"Filter by Product SKU (exact match) - Optional","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/BulkInventoryItem"},"xml":{"name":"BulkInventoryItem","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/Search":{"get":{"tags":["Product"],"summary":"Product Search by SKU/Name","description":"Returns a list of products by searching on SKU and Name","operationId":"Product_SearchProducts","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Search","in":"query","description":"Text to Search","required":true,"type":"string"},{"name":"IncludeBundles","in":"query","description":"Include Bundles in the search","required":false,"type":"boolean","default":false},{"name":"IncludeDiscontinued","in":"query","description":"Include products that have been discontinued in the search","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Product"},"xml":{"name":"Product","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/LookupProductId":{"get":{"tags":["Product"],"summary":"Lookup Product Id","description":"Lookup ProductId using SKU or Alt Code SKU","operationId":"Product_LookupProductId","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"SKU","in":"query","description":"SKU to search","required":true,"type":"string"},{"name":"ConnectMappingType","in":"query","description":"Can be left blank if not searching Alt SKUs. e.g. Amazon, Ebay etc","required":false,"type":"string","default":""},{"name":"ClientId","in":"query","description":"Default 0 - Only needs to be supplied by Admin or Client Master Users","required":false,"type":"integer","format":"int32","default":0}],"responses":{"200":{"description":"OK","schema":{"type":"integer","format":"int32"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/SearchBarcode":{"get":{"tags":["Product"],"summary":"Search Product Barcode","description":"Attempts to find a Product based on the barcode","operationId":"Product_SearchBarcode","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Barcode","in":"query","description":"Product Barcode can be SKU, EAN, UPC based","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Product"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/StockLevels":{"get":{"tags":["Product"],"summary":"Get Stock Levels","description":"Get Stock Levels of Products in Warehouse","operationId":"Product_GetStockLevels","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"WarehouseId","in":"query","description":"WarehouseId that you want to get stock levels for (i.e 3 for warehouse 3, 0 for all warehouses together, blank for all warehouses one by one)","required":false,"type":"integer","format":"int32"},{"name":"Breakdown","in":"query","description":"Include a Breakdown of that StockHolding by Batch, Serial, BestBefore etc","required":false,"type":"boolean","default":false},{"name":"ProductId","in":"query","description":"Product Id - Optional.","required":false,"type":"integer","format":"int32","default":0},{"name":"SKU","in":"query","description":"Product SKU - Optional","required":false,"type":"string"},{"name":"IncludeSubclients","in":"query","description":"Include results for sub clients if user is master client (this feature is currently disabled for most users)","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/StockLevel"},"xml":{"name":"StockLevel","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/StockLevelsByWarehouse":{"get":{"tags":["Product"],"summary":"Get Stock Levels By Warehouse","description":"Get Stock Levels By Warehouse - Raw Stock Levels - Bundles not supported. Based on Inventory so you'll only get results where inventory record exists","operationId":"Product_StockLevelsByWarehouse","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"WarehouseId","in":"query","description":"WarehouseId that you want to get stock levels for (i.e 3 for warehouse 3)","required":true,"type":"integer","format":"int32"},{"name":"LastUpdatedSince","in":"query","description":"Filter list by LastUpdated time supplied so you only get one's that have changed since the supplied datetime","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/StockLevel"},"xml":{"name":"StockLevel","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/Inventory/PreOrderBreakdown":{"get":{"tags":["Product"],"summary":"Get an Inventory Pre Order Breakdown for a specified Product and WarehouseId","description":"Gets InventoryPreOrderBreakdown","operationId":"Product_GetInventoryPreOrderBreakdown","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"},{"name":"WarehouseId","in":"query","description":"WarehouseId ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InventoryPreOrderBreakdown"}},"404":{"description":"Product ID Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/Inventory/PreOrderBreakdown/All":{"get":{"tags":["Product"],"summary":"Get an Inventory Pre Order Breakdown for a specified Product and All Warehouses","description":"Gets InventoryPreOrderBreakdown","operationId":"Product_GetInventoryPreOrderBreakdownAllWarehouses","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/InventoryPreOrderBreakdown"},"xml":{"name":"InventoryPreOrderBreakdown","wrapped":true},"type":"array"}},"404":{"description":"Product ID Not Found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/UpdatedSince":{"get":{"tags":["Product"],"summary":"Products Updated Since","description":"Gets a List of ProductsIds that have been updated since the FromDate supplied","operationId":"Product_GetProductChanges","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"FromDate","in":"query","description":"The Date","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"items":{"type":"integer","format":"int32"},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/StockLevels/UpdatedSince":{"get":{"tags":["Product"],"summary":"Products StockLevels Updated Since","description":"Gets a List of ProductsIds that whose StockLevels have changed since the FromDate supplied","operationId":"Product_GetStockLevelsUpdatedSince","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"FromDate","in":"query","description":"The Date","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"items":{"type":"integer","format":"int32"},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/Suppliers":{"get":{"tags":["Product"],"summary":"List Product Suppliers","description":"Get paged list of Product Suppliers","operationId":"Product_ListSuppliers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"ClientId","in":"query","description":"Filter by Client Id - Admin User Only","required":false,"type":"integer","format":"int32","default":0},{"name":"PageNo","in":"query","description":"Page No - Default 1","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","description":"Number of Results to Return - Default 100 - Max 100","required":false,"type":"integer","format":"int32","default":100}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/ProductSupplier"},"xml":{"name":"ProductSupplier","wrapped":true},"type":"array"}},"400":{"description":"Bad request"}},"security":[{"ms-apikey":[]}]},"put":{"tags":["Product"],"summary":"Create New Product Supplier","description":"Create a New Product Supplier","operationId":"Product_CreateSupplier","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"ProductSupplier","in":"body","description":"ProductSupplier","required":true,"schema":{"$ref":"#/definitions/ProductSupplier"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/BulkOnHandStockUpdate":{"post":{"tags":["Product"],"summary":"Bulk On Hand Stock Update","description":"Update OnHand Stock Level to Provided Level and return results. Must use Integer Values","operationId":"Product_BulkOnHandStockUpdate","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Records","in":"body","description":"Update Requests","required":true,"schema":{"items":{"$ref":"#/definitions/BulkOnHandStockUpdate"},"xml":{"name":"BulkOnHandStockUpdate","wrapped":true},"type":"array"}},{"name":"ClientId","in":"query","description":"Client ID","required":false,"type":"integer","format":"int32","default":0}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/BulkStockUpdateResult"},"xml":{"name":"BulkStockUpdateResult","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Product/{id}/CustomFields":{"post":{"tags":["Product"],"summary":"Add Product Custom Field","description":"Add a Product Custom Field mapping against a Product","operationId":"Product_AddCustomField","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"type":"integer","format":"int32"},{"name":"ProductCustomField","in":"body","required":true,"schema":{"$ref":"#/definitions/ProductCustomField"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/RefData/Countries":{"get":{"tags":["RefData"],"summary":"Get Countries","operationId":"RefData_Countries","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Country"},"xml":{"name":"Country","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/RefData/Currencies":{"get":{"tags":["RefData"],"summary":"Get Currencies","operationId":"RefData_Currencies","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Currency"},"xml":{"name":"Currency","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/RefData/PickingTypes":{"get":{"tags":["RefData"],"summary":"Get Picking Types","operationId":"RefData_PickingTypes","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"type":"string"},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/RefData/PriceTypes":{"get":{"tags":["RefData"],"summary":"Get Product Price Types","operationId":"RefData_PricingTypes","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ProductPriceType"},"xml":{"name":"ProductPriceType","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/ReplenPoints":{"get":{"tags":["ReplenPoint"],"summary":"List Product Replenishment Points","description":"Get a paged list of product replenishment points with optional filters","operationId":"ReplenPoint_ListReplenPoints","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"ProductId","in":"query","description":"Filter by Product ID (optional)","required":false,"type":"integer","format":"int32"},{"name":"SKU","in":"query","description":"Filter by Product SKU (optional)","required":false,"type":"string"},{"name":"LocationTypeId","in":"query","description":"Filter by Location Type ID (optional)","required":false,"type":"integer","format":"int32"},{"name":"PageNo","in":"query","description":"Page number - Default 1","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","description":"Number of results to return - Default 100, Max 100","required":false,"type":"integer","format":"int32","default":100}],"responses":{"200":{"description":"Request Successful","schema":{"items":{"$ref":"#/definitions/ReplenPointResponse"},"xml":{"name":"ReplenPointResponse","wrapped":true},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ReplenPoint":{"post":{"tags":["ReplenPoint"],"summary":"Add New Replenishment Point","description":"Create a new product replenishment point","operationId":"ReplenPoint_AddReplenPoint","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"request","in":"body","description":"Replenishment Point details. Provide either ProductId or SKU, and either LocationTypeId or LocationType name.","required":true,"schema":{"$ref":"#/definitions/ReplenPointRequest"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/ReplenPoint/{id}":{"put":{"tags":["ReplenPoint"],"summary":"Update Existing Replenishment Point","description":"Update an existing product replenishment point","operationId":"ReplenPoint_UpdateReplenPoint","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Replenishment Point ID","required":true,"type":"integer","format":"int32"},{"name":"request","in":"body","description":"Updated replenishment point details. Provide either ProductId or SKU, and either LocationTypeId or LocationType name.","required":true,"schema":{"$ref":"#/definitions/ReplenPointRequest"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"403":{"description":"Access forbidden"},"404":{"description":"Replenishment Point not found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"delete":{"tags":["ReplenPoint"],"summary":"Delete Replenishment Point","description":"Delete a product replenishment point","operationId":"ReplenPoint_DeleteReplenPoint","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Replenishment Point ID","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"403":{"description":"Access forbidden"},"404":{"description":"Replenishment Point not found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Reports/CourierDespatchReport":{"get":{"tags":["Reports"],"summary":"Courier Despatch Report","operationId":"Reports_CourierDespatchReport","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"DespatchDateStart","in":"query","description":"Despatch Start Date","required":true,"type":"string","format":"date-time"},{"name":"DespatchDateEnd","in":"query","description":"Despatch End Date","required":true,"type":"string","format":"date-time"},{"name":"CourierId","in":"query","description":"Optional - Filter the results by Courier","required":false,"type":"integer","format":"int32","default":0},{"name":"WarehouseId","in":"query","description":"Optional - Filter the results by Warehouse","required":false,"type":"integer","format":"int32","default":0},{"name":"BreakdownByCountry","in":"query","description":"Optional - Breakdown the results on Per Country Basis","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/CourierDespatchReportLine"},"xml":{"name":"CourierDespatchReportLine","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Reports/ProductsInLocationReport":{"get":{"tags":["Reports"],"summary":"Products In Location Report - Returns product location data with optional filtering by warehouse, client, location type","operationId":"Reports_ProductsInLocationReport","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"warehouseId","in":"query","description":"Optional - Filter the results by Warehouse","required":false,"type":"integer","format":"int32","default":0},{"name":"clientId","in":"query","description":"Optional - Filter the results by Client","required":false,"type":"integer","format":"int32","default":0},{"name":"locationTypeId","in":"query","description":"Optional - Filter the results by Location Type","required":false,"type":"integer","format":"int32","default":0},{"name":"showOrderAllocations","in":"query","description":"Optional - Include order allocations in results","required":false,"type":"boolean","default":false},{"name":"excludeQuarantine","in":"query","description":"Optional - Exclude quarantine locations","required":false,"type":"boolean","default":false},{"name":"pageNo","in":"query","description":"Optional - Page number for pagination (default: 1)","required":false,"type":"integer","format":"int32","default":1},{"name":"limit","in":"query","description":"Optional - Number of records per page (default: 1000, max: 1000)","required":false,"type":"integer","format":"int32","default":1000},{"name":"sinceUpdated","in":"query","description":"Optional - Only return records updated since this date","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ProductInLocationExportModel"},"xml":{"name":"ProductInLocationExportModel","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Reports/ProductUsageReport":{"get":{"tags":["Reports"],"summary":"Product Usage Report - Returns stock flow data with optional filtering by warehouse, client, product, flow type, date range, and search","operationId":"Reports_ProductUsageReport","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"warehouseId","in":"query","description":"Optional - Filter the results by Warehouse","required":false,"type":"integer","format":"int32","default":0},{"name":"clientId","in":"query","description":"Optional - Filter the results by Client","required":false,"type":"integer","format":"int32","default":0},{"name":"productId","in":"query","description":"Optional - Filter the results by Product","required":false,"type":"integer","format":"int32","default":0},{"name":"flow","in":"query","description":"Optional - Filter the results by Flow Type (e.g., IN, OUT, ALLOCATE, UNALLOCATE)","required":false,"type":"string"},{"name":"fromDate","in":"query","description":"Optional - Filter results from this date","required":false,"type":"string","format":"date-time"},{"name":"toDate","in":"query","description":"Optional - Filter results to this date","required":false,"type":"string","format":"date-time"},{"name":"includeDetails","in":"query","description":"Optional - Include a breakdown of the details like Location, batch numbers and serial numbers","required":false,"type":"boolean","default":false},{"name":"search","in":"query","description":"Optional - General search across reason, user, SKU, and batch numbers","required":false,"type":"string"},{"name":"pageNo","in":"query","description":"Optional - Page number for pagination (default: 1)","required":false,"type":"integer","format":"int32","default":1},{"name":"limit","in":"query","description":"Optional - Number of records per page (default: 1000, max: 1000)","required":false,"type":"integer","format":"int32","default":1000}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/StockFlowTableRow"},"xml":{"name":"StockFlowTableRow","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/Reasons":{"get":{"tags":["Return"],"operationId":"Return_GetReturnReasons","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ReturnReason"},"xml":{"name":"ReturnReason","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/{id}":{"get":{"tags":["Return"],"operationId":"Return_GetReturn","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Return"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/{id}/Items":{"get":{"tags":["Return"],"operationId":"Return_GetReturnItems","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ReturnItem"},"xml":{"name":"ReturnItem","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/SearchByDate":{"get":{"tags":["Return"],"operationId":"Return_GetReturnsOnDate","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Date","in":"query","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Return"},"xml":{"name":"Return","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/CreateReturn/{OrderId}":{"post":{"tags":["Return"],"summary":"Creates the return for a specified warehouse, or in the order's warehouse if null.","operationId":"Return_CreateReturn","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderId","in":"path","description":"The ID of the order for which to create a return.","required":true,"type":"integer","format":"int32"},{"name":"WarehouseId","in":"query","description":"Optional - The Warehouse in which to create the return.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/CreateExternalReturn":{"post":{"tags":["Return"],"summary":"Creates an external return (not linked to an order).\r\nExtra Fields should be pre-configured in the system (Extra Fields, type Returns_External) prior to use.","operationId":"Return_CreateExternalReturn","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"request","in":"body","description":"The external return request containing ClientId, WarehouseId, ReturnItems, and Extra Fields.","required":true,"schema":{"$ref":"#/definitions/CreateExternalReturnRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/{id}/AddItem":{"post":{"tags":["Return"],"operationId":"Return_AddReturnItem","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"Item","in":"body","required":true,"schema":{"$ref":"#/definitions/ReturnItemAPI"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/{id}/AllocateItemLocation":{"post":{"tags":["Return"],"operationId":"Return_AllocateItemLocation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"ReturnitemId","in":"query","required":true,"type":"integer","format":"int32"},{"name":"Quantity","in":"query","required":true,"type":"integer","format":"int32"},{"name":"LocationId","in":"query","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/{id}/Confirm":{"post":{"tags":["Return"],"operationId":"Return_ConfirmReturn","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Return/List":{"get":{"tags":["Return"],"operationId":"Return_ListReturns","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"ClientId","in":"query","required":false,"type":"integer","format":"int32","default":0},{"name":"WarehouseId","in":"query","required":false,"type":"integer","format":"int32","default":0},{"name":"PageNo","in":"query","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","required":false,"type":"integer","format":"int32","default":100},{"name":"SinceLastUpdated","in":"query","required":false,"type":"string","format":"date-time"},{"name":"Confirmed","in":"query","required":false,"type":"boolean"},{"name":"IncludeReturnItems","in":"query","required":false,"type":"boolean","default":false},{"name":"ExternalOnly","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Return"},"xml":{"name":"Return","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse/LocationTypes":{"get":{"tags":["Warehouse"],"operationId":"Warehouse_GetLocationTypes","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/LocationType"},"xml":{"name":"LocationType","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse":{"get":{"tags":["Warehouse"],"operationId":"Warehouse_GetWarehouses","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Warehouse"},"xml":{"name":"Warehouse","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse/{WarehouseId}/Location/All":{"get":{"tags":["Warehouse"],"operationId":"Warehouse_GetLocations","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"WarehouseId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"IncludeUnAssigned","in":"query","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Location"},"xml":{"name":"Location","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse/{WarehouseId}/Location/{LocationId}":{"get":{"tags":["Warehouse"],"operationId":"Warehouse_GetLocation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"WarehouseId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"LocationId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Location"}}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse/{WarehouseId}/Location/LookupLocationId":{"get":{"tags":["Warehouse"],"operationId":"Warehouse_LookupLocationId","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"WarehouseId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"Location","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Location"}}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse/{warehouseId}/StockMovements":{"get":{"tags":["Warehouse"],"summary":"Get a List of Stock Movements that have happened in a warehouse e.g. moving stock from one location to another","operationId":"Warehouse_StockMovements","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"warehouseId","in":"path","description":"ID of the warehouse","required":true,"type":"integer","format":"int32"},{"name":"productId","in":"query","description":"Product ID - Optional","required":false,"type":"integer","format":"int32"},{"name":"pageNo","in":"query","description":"Page No - Default 1","required":false,"type":"integer","format":"int32","default":1},{"name":"limit","in":"query","description":"Max number of results to return - Default 100 - Max 100","required":false,"type":"integer","format":"int32","default":100},{"name":"sinceDate","in":"query","description":"filter to only get results since a certain date - useful last 24 hours etc","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/StockMovementDTO"},"xml":{"name":"StockMovementDTO","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse/StockMovement":{"post":{"tags":["Warehouse"],"operationId":"Warehouse_StockMovement","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Action","in":"query","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19]},{"name":"Request","in":"body","required":true,"schema":{"$ref":"#/definitions/BookStockRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ToolkitResult"}}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse/BulkStockMovement":{"post":{"tags":["Warehouse"],"operationId":"Warehouse_BulkStockMovement","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"Action","in":"query","required":true,"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19]},{"name":"Requests","in":"body","required":true,"schema":{"items":{"$ref":"#/definitions/BookStockRequest"},"xml":{"name":"BookStockRequest","wrapped":true},"type":"array"}}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ToolkitResult"},"xml":{"name":"ToolkitResult","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/WarehouseTransfer":{"put":{"tags":["Warehouse"],"summary":"Create new WarehouseTransfer","description":"Used to Creating a new WarehouseTransfer i.e. Advising of a Delivery into the Warehouse","operationId":"Warehouse_CreateWarehouseTransfer","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"WarehouseTransfer","in":"body","description":"WarehouseTransfer Json in the Body of the request","required":true,"schema":{"$ref":"#/definitions/APIWarehouseTransfer"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"404":{"description":"WarehouseTransfer with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/WarehouseTransfer/List":{"get":{"tags":["Warehouse"],"operationId":"Warehouse_ListWarehouseTransfers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"IncludeWarehouseTransferItems","in":"query","required":false,"type":"boolean","default":false},{"name":"WarehouseTransferStatuses","in":"query","required":false,"type":"string"},{"name":"PageNo","in":"query","required":false,"type":"integer","format":"int32","default":1},{"name":"Limit","in":"query","required":false,"type":"integer","format":"int32","default":100},{"name":"ClientId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"SourceWarehouseId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"DestinationWarehouseId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"SinceLastUpdated","in":"query","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ToReturnWarehouseTransfer"},"xml":{"name":"ToReturnWarehouseTransfer","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/WarehouseTransfer/{id}":{"get":{"tags":["Warehouse"],"summary":"Get WarehouseTransfer","description":"Get back latest details about an Existing WarehouseTransfer","operationId":"Warehouse_GetWarehouseTransfer","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the WarehouseTransfer","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/WarehouseTransfer"}},"400":{"description":"Bad request"},"404":{"description":"WarehouseTransfer with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"post":{"tags":["Warehouse"],"summary":"Update WarehouseTransfer Details","description":"Update WarehouseTransfer Details for an Existing WarehouseTransfer (Excluding Items)","operationId":"Warehouse_UpdateWarehouseTransfer","consumes":["application/json","text/json"],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the WarehouseTransfer","required":true,"type":"integer","format":"int32"},{"name":"WarehouseTransfer","in":"body","required":true,"schema":{"$ref":"#/definitions/APIWarehouseTransfer"}}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"WarehouseTransfer with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]},"delete":{"tags":["Warehouse"],"summary":"Delete WarehouseTransfer","description":"Delete WarehouseTransfer - Cannot be undone","operationId":"Warehouse_DeleteWarehouseTransfer","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the WarehouseTransfer","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"WarehouseTransfer with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/WarehouseTransfer/Statuses":{"get":{"tags":["Warehouse"],"summary":"Get WarehouseTransfer Statuses","description":"Get a list of Possible WarehouseTransferStatuses within the system","operationId":"Warehouse_GetStatuses","consumes":[],"produces":["application/json","text/json"],"responses":{"200":{"description":"Request Successful","schema":{"items":{"type":"string"},"type":"array"}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/WarehouseTransfer/{id}/Confirm":{"get":{"tags":["Warehouse"],"summary":"Confirm WarehouseTransfer","description":"Confirm WarehouseTransfer is now ready to be expected in the warehouse","operationId":"Warehouse_ConfirmWarehouseTransfer","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the WarehouseTransfer","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"404":{"description":"WarehouseTransfer with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/WarehouseTransfer/{id}/Cancel":{"get":{"tags":["Warehouse"],"summary":"Cancel WarehouseTransfer","description":"Cancel WarehouseTransfer","operationId":"Warehouse_CancelWarehouseTransfer","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"ID of the WarehouseTransfer","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Request Successful","schema":{"$ref":"#/definitions/ToolkitResult"}},"400":{"description":"Bad request"},"403":{"description":"Invalid User Permissions to perform Request"},"404":{"description":"WarehouseTransfer with the supplied ID cannot be found"},"500":{"description":"Internal Server Error"}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse/{id}/Zones":{"get":{"tags":["Warehouse"],"operationId":"Warehouse_GetWarehouseZones","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Zone"},"xml":{"name":"Zone","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}},"/api/Warehouse/{id}/ToteBreakdown":{"get":{"tags":["Warehouse"],"summary":"Returns Items in Tote and associated Product Dimensions","operationId":"Warehouse_GetToteBreakdown","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","description":"Warehouse ID","required":true,"type":"integer","format":"int32"},{"name":"toteBarcode","in":"query","description":"Tote Barcode","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/ItemInTote"},"xml":{"name":"ItemInTote","wrapped":true},"type":"array"}}},"security":[{"ms-apikey":[]}]}}},"definitions":{"ConfirmedInvoiceSummary":{"properties":{"ClientId":{"type":"integer","format":"int32"},"Date":{"type":"string","format":"date-time"},"Name":{"type":"string"},"Comments":{"type":"string"},"NumberOfParcels":{"type":"integer","format":"int32"},"NumberOfItems":{"type":"integer","format":"int32"},"PickingCost":{"type":"number","format":"double"},"PostageCost":{"type":"number","format":"double"},"VatFreePostageCost":{"type":"number","format":"double"},"ReworkCost":{"type":"number","format":"double"},"PackagingCost":{"type":"number","format":"double"},"GenericInvoiceItemsCost":{"type":"number","format":"double"},"CollectionsCost":{"type":"number","format":"double"},"ReturnsCost":{"type":"number","format":"double"},"GoodsInCost":{"type":"number","format":"double"},"StorageCost":{"type":"number","format":"double"},"AdminFee":{"type":"number","format":"double"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ConfirmedInvoiceSummary"},"type":"object"},"InvoiceItem":{"properties":{"OrderId":{"type":"integer","format":"int32"},"CourierServiceId":{"type":"integer","format":"int32"},"InvoiceSummaryId":{"type":"integer","format":"int32"},"PickingCost":{"type":"number","format":"double"},"ExtraPickingCost":{"type":"number","format":"double"},"PostageCost":{"type":"number","format":"double"},"CostPostageCost":{"type":"number","format":"double"},"VatFreePostageCost":{"type":"number","format":"double"},"PackagingCost":{"type":"number","format":"double"},"ReworkCost":{"type":"number","format":"double"},"InvoiceDate":{"type":"string","format":"date-time"},"Comments":{"type":"string"},"NumberOfPicks":{"type":"integer","format":"int32"},"NumberOfCartonPicks":{"type":"integer","format":"int32"},"NumberOfPalletPicks":{"type":"integer","format":"int32"},"AdminFee":{"type":"number","format":"double"},"TotalCost":{"readOnly":true,"type":"number","format":"double"},"TotalPickingCost":{"readOnly":true,"type":"number","format":"double"},"TotalPostageCost":{"readOnly":true,"type":"number","format":"double"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"InvoiceItem"},"type":"object"},"AddCourierCostRequest":{"properties":{"OrderId":{"type":"integer","format":"int32"},"OrderNumber":{"type":"string"},"Client":{"type":"string"},"TrackingNumber":{"type":"string"},"PostageCost":{"type":"number","format":"double"},"VatFree":{"type":"boolean"},"CostPostageCost":{"type":"number","format":"double"}},"xml":{"name":"AddCourierCostRequest"},"type":"object"},"ToolkitResult":{"properties":{"ID":{"type":"integer","format":"int32"},"Success":{"type":"boolean"},"SensitiveData":{"type":"string"},"Message":{"type":"string"},"WarningMessage":{"type":"string"},"AllocatedFromReplen":{"type":"boolean"}},"xml":{"name":"ToolkitResult"},"type":"object"},"ReturnInvoiceItem":{"properties":{"ReturnId":{"type":"integer","format":"int32"},"InvoiceSummaryId":{"type":"integer","format":"int32"},"InvoiceDate":{"type":"string","format":"date-time"},"Cost":{"type":"number","format":"double"},"Comments":{"type":"string"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ReturnInvoiceItem"},"type":"object"},"GoodsInInvoiceItem":{"properties":{"InvoiceSummaryId":{"type":"integer","format":"int32"},"InvoiceDate":{"type":"string","format":"date-time"},"ASNId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"Note":{"type":"string"},"DeliverySizeCost":{"type":"number","format":"double"},"NumberOfUnits":{"type":"integer","format":"int32"},"UnitCost":{"type":"number","format":"double"},"AdminCost":{"type":"number","format":"double"},"TotalUnitCost":{"readOnly":true,"type":"number","format":"double"},"NumberOfSkus":{"type":"integer","format":"int32"},"SkuCost":{"type":"number","format":"double"},"TotalPerSkuCost":{"readOnly":true,"type":"number","format":"double"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"GoodsInInvoiceItem"},"type":"object"},"CollectionInvoiceItem":{"properties":{"CollectionId":{"type":"integer","format":"int32"},"InvoiceSummaryId":{"type":"integer","format":"int32"},"CollectionServiceId":{"type":"integer","format":"int32"},"InvoiceDate":{"type":"string","format":"date-time"},"Cost":{"type":"number","format":"double"},"Comments":{"type":"string"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"CollectionInvoiceItem"},"type":"object"},"GenericInvoiceItem":{"properties":{"InvoiceSummaryId":{"type":"integer","format":"int32"},"InvoiceItemTypeId":{"type":"integer","format":"int32"},"WarehouseId":{"type":"integer","format":"int32"},"InvoiceDate":{"type":"string","format":"date-time"},"Cost":{"type":"number","format":"double"},"Comments":{"type":"string"},"AddedBy":{"type":"string"},"Warehouse":{"$ref":"#/definitions/Warehouse"},"InvoiceItemType":{"$ref":"#/definitions/InvoiceItemType"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"GenericInvoiceItem"},"type":"object"},"Warehouse":{"required":["Name","AddressLine1","City","PostCode","CompanyName","ContactName","ContactNumber","ContactEmail"],"properties":{"Name":{"type":"string","maxLength":50,"minLength":0},"Code":{"type":"string","maxLength":20,"minLength":0},"Details":{"type":"string"},"AllowTransfersIn":{"type":"boolean"},"AllowAllocatedTransfers":{"type":"boolean"},"AllowUnassignedLocations":{"type":"boolean"},"AllocateBasedOnLocationTypePriority":{"type":"boolean"},"IncludeAllocatedStockInReplenPoint":{"type":"boolean"},"VerifyLocationsWhenPicking":{"type":"boolean"},"Active":{"type":"boolean"},"Type":{"type":"string"},"PrependWarehouseName":{"type":"boolean"},"AddressLine1":{"type":"string","maxLength":50,"minLength":0},"AddressLine2":{"type":"string","maxLength":50,"minLength":0},"City":{"type":"string","maxLength":50,"minLength":0},"County":{"type":"string","maxLength":50,"minLength":0},"PostCode":{"type":"string","maxLength":20,"minLength":0},"CompanyName":{"type":"string","maxLength":50,"minLength":0},"ContactName":{"type":"string","maxLength":50,"minLength":0},"ContactNumber":{"type":"string","maxLength":50,"minLength":0},"ContactEmail":{"type":"string","maxLength":50,"minLength":0},"CountryId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"},"WarehouseReferenceFields":{"items":{"$ref":"#/definitions/WarehouseReferenceField"},"xml":{"name":"WarehouseReferenceField","wrapped":true},"type":"array"}},"xml":{"name":"Warehouse"},"type":"object"},"InvoiceItemType":{"properties":{"Name":{"type":"string"},"Rate":{"type":"number","format":"double"},"ChargeType":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"InvoiceItemType"},"type":"object"},"WarehouseReferenceField":{"properties":{"WarehouseId":{"type":"integer","format":"int32"},"Name":{"type":"string","maxLength":100,"minLength":0},"Value":{"type":"string"},"Connection":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"WarehouseReferenceField"},"type":"object"},"AddLocationTypeStoragePriceRequest":{"properties":{"Client":{"type":"string"},"ClientId":{"type":"integer","format":"int32"},"LocationType":{"type":"string"},"Cost":{"type":"number","format":"double"},"Frequency":{"type":"string"}},"xml":{"name":"AddLocationTypeStoragePriceRequest"},"type":"object"},"InvoiceSummary":{"properties":{"NumberOfParcels":{"type":"integer","format":"int32"},"NumberOfItems":{"type":"integer","format":"int32"},"PickingCost":{"type":"number","format":"double"},"PostageCost":{"type":"number","format":"double"},"VatFreePostageCost":{"type":"number","format":"double"},"ReworkCost":{"type":"number","format":"double"},"PackagingCost":{"type":"number","format":"double"},"GenericInvoiceItemsCost":{"type":"number","format":"double"},"CollectionsCost":{"type":"number","format":"double"},"ReturnsCost":{"type":"number","format":"double"},"GoodsInCost":{"type":"number","format":"double"},"StorageCost":{"type":"number","format":"double"},"AdminFee":{"type":"number","format":"double"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"InvoiceSummary"},"type":"object"},"StorageInvoiceItem":{"properties":{"InvoiceSummaryId":{"type":"integer","format":"int32"},"InvoiceDate":{"type":"string","format":"date-time"},"Type":{"type":"string"},"Cost":{"type":"number","format":"double"},"Comments":{"type":"string"},"WarehouseId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"StorageInvoiceItem"},"type":"object"},"NewASN":{"properties":{"WarehouseId":{"type":"integer","format":"int32"},"POReference":{"type":"string"},"Supplier":{"type":"string","maxLength":250,"minLength":0},"SupplierNotes":{"type":"string"},"EstimatedDelivery":{"type":"string","format":"date-time"},"Comments":{"type":"string"},"GoodsInType":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"ProductSupplierId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"Items":{"items":{"$ref":"#/definitions/NewASNItem"},"xml":{"name":"NewASNItem","wrapped":true},"type":"array"}},"xml":{"name":"NewASN"},"type":"object"},"NewASNItem":{"properties":{"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"SourceLineId":{"type":"string"},"SSCCNumber":{"type":"string"}},"xml":{"name":"NewASNItem"},"type":"object"},"ASN":{"properties":{"CLIENTSHORTNAME":{"readOnly":true,"type":"string"},"POReference":{"type":"string"},"Supplier":{"type":"string","maxLength":250,"minLength":0},"ProductSupplierId":{"type":"integer","format":"int32"},"ProductSupplier":{"type":"string"},"EstimatedDelivery":{"type":"string","format":"date-time"},"EstimatedTimeToDock":{"type":"string","format":"date-time"},"WarehouseBookedDate":{"type":"string","format":"date-time"},"BookedInDate":{"type":"string","format":"date-time"},"Comments":{"type":"string"},"GoodsInType":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"ASNStatus":{"$ref":"#/definitions/ASNStatus"},"ASNStatusId":{"type":"integer","format":"int32"},"Shipped":{"type":"boolean"},"HoursLogged":{"type":"number","format":"double"},"Items":{"items":{"$ref":"#/definitions/ASNItem"},"xml":{"name":"ASNItem","wrapped":true},"type":"array"},"WarehouseId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ASN"},"type":"object"},"ASNStatus":{"properties":{"Name":{"type":"string"},"Colour":{"type":"string"},"TextColour":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ASNStatus"},"type":"object"},"ASNItem":{"properties":{"ASNId":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"QuantityExpected":{"type":"integer","format":"int32"},"QuantityReceieved":{"type":"integer","format":"int32"},"QuantityBooked":{"type":"integer","format":"int32"},"OnOrder":{"type":"integer","format":"int32"},"SSCCNumber":{"type":"string"},"Complete":{"type":"boolean"},"Comments":{"type":"string","maxLength":500,"minLength":0},"SourceLineId":{"type":"string"},"ASNItemNameValues":{"items":{"$ref":"#/definitions/ASNItemNameValue"},"xml":{"name":"ASNItemNameValue","wrapped":true},"type":"array"},"SKU":{"readOnly":true,"type":"string"},"EAN":{"readOnly":true,"type":"string"},"UPC":{"readOnly":true,"type":"string"},"NAME":{"readOnly":true,"type":"string"},"HasSerialNumber":{"readOnly":true,"type":"boolean"},"HasExpiryDate":{"readOnly":true,"type":"boolean"},"HasBatchNumber":{"readOnly":true,"type":"boolean"},"ProductImageURL":{"readOnly":true,"type":"string"},"ASNItemAllocations":{"items":{"$ref":"#/definitions/ASNItemAllocation"},"xml":{"name":"ASNItemAllocation","wrapped":true},"type":"array"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ASNItem"},"type":"object"},"ASNItemNameValue":{"properties":{"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ASNItemNameValue"},"type":"object"},"ASNItemAllocation":{"properties":{"ASNItemId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"LocationId":{"type":"integer","format":"int32"},"ExpiryDate":{"type":"string","format":"date-time"},"BatchNo":{"type":"string"},"SerialNo":{"type":"string"},"Complete":{"type":"boolean"},"RobotPutaway":{"type":"boolean"},"StorageItemId":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ASNItemAllocation"},"type":"object"},"NewASNConnectAction":{"properties":{"Type":{"type":"string"},"SourceASNId":{"type":"string"},"AccountId":{"type":"integer","format":"int32"},"ExtraCode1":{"type":"string"},"ExtraCode2":{"type":"string"},"ExtraCode3":{"type":"string"},"ExtraCode4":{"type":"string"}},"xml":{"name":"NewASNConnectAction"},"type":"object"},"EnumPair":{"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string"}},"xml":{"name":"EnumPair"},"type":"object"},"MintsoftAuthRequest":{"properties":{"Username":{"type":"string"},"Password":{"type":"string"}},"xml":{"name":"MintsoftAuthRequest"},"type":"object"},"NewBatch":{"properties":{"OrderIds":{"items":{"type":"integer","format":"int32"},"type":"array"},"Reference":{"type":"string"},"ID":{"type":"integer","format":"int32"},"Success":{"type":"boolean"},"SensitiveData":{"type":"string"},"Message":{"type":"string"},"WarningMessage":{"type":"string"},"AllocatedFromReplen":{"type":"boolean"}},"xml":{"name":"NewBatch"},"type":"object"},"Batch":{"properties":{"Reference":{"type":"string"},"NumberOfOrders":{"type":"integer","format":"int32"},"MobilePickingType":{"type":"string"},"MobilePickingPriority":{"type":"integer","format":"int32"},"AssignedUser":{"type":"string"},"PickingStarted":{"type":"boolean"},"PickingComplete":{"type":"boolean"},"Despatched":{"type":"boolean"},"ItemsSkipped":{"type":"boolean"},"AssignedTote":{"type":"string"},"Created":{"type":"string","format":"date-time"},"LastPickInteraction":{"type":"string","format":"date-time"},"SpotCheckOverride":{"type":"integer","format":"int32"},"WarehouseId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Batch"},"type":"object"},"Order":{"required":["ClientId","OrderNumber","FirstName","Address1","PostCode","CountryId","CourierServiceTypeId"],"properties":{"ClientId":{"type":"integer","format":"int32"},"CLIENT_CODE":{"readOnly":true,"type":"string"},"OrderNumber":{"type":"string","maxLength":250,"minLength":0},"ExternalOrderReference":{"type":"string","maxLength":250,"minLength":0},"OrderDate":{"type":"string","format":"date-time"},"DespatchDate":{"type":"string","format":"date-time"},"AtNewDate":{"type":"string","format":"date-time"},"SLAWarningDate":{"type":"string","format":"date-time"},"SLADespatchDate":{"type":"string","format":"date-time"},"RequiredDespatchDate":{"type":"string","format":"date-time"},"RequiredDeliveryDate":{"type":"string","format":"date-time"},"Title":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"CompanyName":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"Address3":{"type":"string"},"Town":{"type":"string"},"County":{"type":"string"},"PostCode":{"type":"string","maxLength":20,"minLength":0},"Phone":{"type":"string","maxLength":50,"minLength":0},"Mobile":{"type":"string","maxLength":50,"minLength":0},"Email":{"type":"string"},"CountryId":{"type":"integer","format":"int32"},"Country":{"$ref":"#/definitions/Country"},"Source":{"type":"string"},"Comments":{"type":"string"},"GiftMessages":{"type":"string","maxLength":1000,"minLength":0},"DeliveryNotes":{"type":"string","maxLength":1000,"minLength":0},"VATNumber":{"type":"string","maxLength":50,"minLength":0},"EORINumber":{"type":"string","maxLength":20,"minLength":0},"UKIMSNumber":{"type":"string","maxLength":50,"minLength":0},"RFCNumber":{"type":"string","maxLength":50,"minLength":0},"PIDNumber":{"type":"string"},"OrderStatusId":{"type":"integer","format":"int32"},"NumberOfParcels":{"type":"integer","format":"int32","maximum":1000,"minimum":1},"TotalItems":{"type":"integer","format":"int32"},"TotalWeight":{"type":"number","format":"double"},"OrderValue":{"type":"number","format":"double"},"Part":{"type":"integer","format":"int32"},"NumberOfParts":{"type":"integer","format":"int32"},"CourierServiceTypeId":{"type":"integer","format":"int32"},"CourierServiceId":{"type":"integer","format":"int32"},"CourierServiceName":{"type":"string"},"TrackingNumber":{"type":"string"},"TrackingURL":{"readOnly":true,"type":"string"},"ShippingTotalExVat":{"type":"number","format":"double"},"ShippingTotalVat":{"type":"number","format":"double"},"DiscountTotalExVat":{"type":"number","format":"double"},"DiscountTotalVat":{"type":"number","format":"double"},"TotalVat":{"type":"number","format":"double"},"PIIRemoved":{"type":"boolean"},"ShippingNet":{"type":"number","format":"double"},"ShippingTax":{"type":"number","format":"double"},"ShippingGross":{"readOnly":true,"type":"number","format":"double"},"DiscountNet":{"type":"number","format":"double"},"DiscountTax":{"type":"number","format":"double"},"TotalOrderNet":{"type":"number","format":"double"},"TotalOrderTax":{"type":"number","format":"double"},"TotalOrderGross":{"type":"number","format":"double"},"DiscountGross":{"readOnly":true,"type":"number","format":"double"},"WarehouseId":{"type":"integer","format":"int32"},"WAREHOUSE_CODE":{"readOnly":true,"type":"string"},"ChannelId":{"type":"integer","format":"int32"},"Channel":{"$ref":"#/definitions/Channel"},"CurrencyId":{"type":"integer","format":"int32"},"Currency":{"$ref":"#/definitions/Currency"},"DespatchedByUser":{"type":"string"},"OrderItems":{"items":{"$ref":"#/definitions/OrderItem"},"xml":{"name":"OrderItem","wrapped":true},"type":"array"},"OrderNameValues":{"items":{"$ref":"#/definitions/OrderNameValue"},"xml":{"name":"OrderNameValue","wrapped":true},"type":"array"},"OrderLock":{"type":"boolean"},"RecipientType":{"$ref":"#/definitions/RecipientTypeLegacyObject","readOnly":true},"Tags":{"type":"string"},"SourceOrderDate":{"type":"string","format":"date-time"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Order"},"type":"object"},"Country":{"properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Code3":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Country"},"type":"object"},"Channel":{"required":["Name"],"properties":{"Name":{"type":"string","pattern":"^[^\"'&<>()–]+$"},"Description":{"type":"string"},"Active":{"type":"boolean"},"Logo":{"type":"string","pattern":"^[^\"'&<>()–]+$"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Channel"},"type":"object"},"Currency":{"required":["Name","Code"],"properties":{"Name":{"type":"string","maxLength":100,"minLength":0},"Code":{"type":"string","maxLength":3,"minLength":0},"Symbol":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Currency"},"type":"object"},"OrderItem":{"properties":{"OrderId":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"Allocated":{"type":"integer","format":"int32"},"Commited":{"type":"integer","format":"int32"},"OnBackOrder":{"type":"integer","format":"int32"},"SourceLineSubTotal":{"type":"number","format":"double"},"SourceLineTotalTax":{"type":"number","format":"double"},"SourceLineTotalDiscount":{"type":"number","format":"double"},"SourceLineTotal":{"type":"number","format":"double"},"Price":{"type":"number","format":"double"},"Vat":{"type":"number","format":"double"},"Discount":{"type":"number","format":"double"},"PriceNet":{"type":"number","format":"double"},"Tax":{"type":"number","format":"double"},"DiscountGross":{"type":"number","format":"double"},"TaxRate":{"type":"number","format":"double"},"DiscountNet":{"type":"number","format":"double"},"DiscountTax":{"type":"number","format":"double"},"NetPaid":{"readOnly":true,"type":"number","format":"double"},"TaxPaid":{"readOnly":true,"type":"number","format":"double"},"TotalTax":{"readOnly":true,"type":"number","format":"double"},"Details":{"type":"string"},"SKU":{"readOnly":true,"type":"string"},"OrderItemNameValues":{"items":{"$ref":"#/definitions/OrderItemNameValue"},"xml":{"name":"OrderItemNameValue","wrapped":true},"type":"array"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderItem"},"type":"object"},"OrderNameValue":{"properties":{"OrderId":{"type":"integer","format":"int32"},"Name":{"type":"string","maxLength":100,"minLength":0},"Value":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderNameValue"},"type":"object"},"RecipientTypeLegacyObject":{"properties":{"Name":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"RecipientTypeLegacyObject"},"type":"object"},"OrderItemNameValue":{"properties":{"Name":{"type":"string","maxLength":100,"minLength":0},"Value":{"type":"string"},"Internal":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderItemNameValue"},"type":"object"},"BatchTemplate":{"properties":{"Reference":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"BatchTemplate"},"type":"object"},"Client":{"required":["ShortName","Name"],"properties":{"ShortName":{"type":"string","maxLength":30,"minLength":0},"Name":{"type":"string","maxLength":50,"minLength":0},"Code":{"type":"string","maxLength":50,"minLength":0},"BrandName":{"type":"string","maxLength":50,"minLength":0},"ContactName":{"type":"string","maxLength":50,"minLength":0},"ContactNumber":{"type":"string","maxLength":50,"minLength":0},"AddressLine1":{"type":"string","maxLength":50,"minLength":0},"AddressLine2":{"type":"string","maxLength":50,"minLength":0},"AddressLine3":{"type":"string","maxLength":50,"minLength":0},"Town":{"type":"string","maxLength":50,"minLength":0},"County":{"type":"string","maxLength":50,"minLength":0},"Postcode":{"type":"string","maxLength":50,"minLength":0},"PPINumber":{"type":"string","maxLength":50,"minLength":0},"VATNumber":{"type":"string","maxLength":50,"minLength":0},"EORINumber":{"type":"string","maxLength":50,"minLength":0},"UKIMSNumber":{"type":"string","maxLength":50,"minLength":0},"VOECNumber":{"type":"string","maxLength":10,"minLength":0},"DefaultMIDCode":{"type":"string","maxLength":30,"minLength":0},"VatExempt":{"type":"boolean"},"NIREORINumber":{"type":"string","maxLength":50,"minLength":0},"IOSSNumber":{"type":"string","maxLength":50,"minLength":0},"CountryId":{"type":"integer","format":"int32"},"ContactEmail":{"type":"string","maxLength":100,"minLength":0},"PackagingInstructions":{"type":"string"},"CurrencyId":{"type":"integer","format":"int32"},"Active":{"type":"string"},"OnStop":{"type":"boolean"},"AccountingIntegrationType":{"type":"string","maxLength":100,"minLength":0},"CustomerRegistrationNumber":{"type":"string","maxLength":8,"minLength":0},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Client"},"type":"object"},"CreateClient":{"properties":{"ShortName":{"type":"string","maxLength":30,"minLength":0},"Name":{"type":"string","maxLength":50,"minLength":0},"Code":{"type":"string","maxLength":50,"minLength":0},"BrandName":{"type":"string","maxLength":50,"minLength":0},"ContactName":{"type":"string","maxLength":50,"minLength":0},"ContactNumber":{"type":"string","maxLength":50,"minLength":0},"AddressLine1":{"type":"string","maxLength":50,"minLength":0},"AddressLine2":{"type":"string","maxLength":50,"minLength":0},"AddressLine3":{"type":"string","maxLength":50,"minLength":0},"Town":{"type":"string","maxLength":50,"minLength":0},"County":{"type":"string","maxLength":50,"minLength":0},"Postcode":{"type":"string","maxLength":50,"minLength":0},"CountryId":{"type":"integer","format":"int32"},"AdditionalInfo":{"type":"string","maxLength":50,"minLength":0},"ContactEmail":{"type":"string","maxLength":100,"minLength":0},"OnStop":{"type":"boolean"},"AccountingIntegrationType":{"type":"string","maxLength":100,"minLength":0},"CustomerRegistrationNumber":{"type":"string","maxLength":8,"minLength":0},"VATNumber":{"type":"string","maxLength":50,"minLength":0},"EORINumber":{"type":"string","maxLength":50,"minLength":0},"NIREORINumber":{"type":"string","maxLength":50,"minLength":0},"IOSSNumber":{"type":"string","maxLength":50,"minLength":0},"PPINumber":{"type":"string","maxLength":50,"minLength":0},"UKIMSNumber":{"type":"string","maxLength":50,"minLength":0},"VOECNumber":{"type":"string","maxLength":10,"minLength":0},"VatExempt":{"type":"boolean"},"DefaultCustomsDescription":{"type":"string","maxLength":50,"minLength":0},"DefaultMIDCode":{"type":"string","maxLength":30,"minLength":0},"CountryOfManufactureId":{"type":"integer","format":"int32"},"DefaultCommodityCode":{"type":"string","maxLength":50,"minLength":0},"DefaultMaterial":{"type":"string","maxLength":50,"minLength":0},"PickingCalculationType":{"type":"string"},"TieredPricingInvoiceFrequency":{"type":"string"},"StandardPickingCost":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"AdditionalPickingCostPerItem":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"NumberOfItemsIncludedInStandardPick":{"type":"integer","format":"int32","maximum":100,"minimum":1},"EnableCartonPickingCost":{"type":"boolean"},"StandardCartonPickingCost":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"AdditionalPickingCostPerCarton":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"EnablePalletPickingCost":{"type":"boolean"},"StandardPalletPickingCost":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"AdditionalPickingCostPerPallet":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"PickingSKUCost":{"type":"number","format":"double","maximum":5000.0,"minimum":0.0},"PercentageOfOrderValuePickingCost":{"type":"number","format":"double","maximum":100,"minimum":0},"ReturnsCostFirstItem":{"type":"number","format":"double","maximum":5000.0,"minimum":0.0},"ReturnsCostAdditionalItem":{"type":"number","format":"double","maximum":5000.0,"minimum":0.0},"DefaultPackagingFee":{"type":"number","format":"double"},"PickingCostPerCBM":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"PerOrderAdminFee":{"type":"number","format":"double"},"StockManagementFee":{"type":"number","format":"double","maximum":500000.0,"minimum":0.0},"VolumetricStorageFee":{"type":"number","format":"double","maximum":5000.0,"minimum":0.0},"VolumetricStorageFrequency":{"type":"string"},"StorageType":{"type":"string"},"AutoCalculateVolumetricStorage":{"type":"boolean"},"GoodsInCostCarton":{"type":"number","format":"double"},"GoodsInCostPallet":{"type":"number","format":"double"},"GoodsInCost20ftContainer":{"type":"number","format":"double"},"GoodsInCost40ftContainer":{"type":"number","format":"double"},"GoodsInCost40ftContainerHC":{"type":"number","format":"double"},"GoodsInCost45ftContainer":{"type":"number","format":"double"},"GoodsInCost45ftContainerHC":{"type":"number","format":"double"},"GoodsInCostSku":{"type":"number","format":"double"},"GoodsInCostUnit":{"type":"number","format":"double"},"AdminChargePerASN":{"type":"number","format":"double"},"HourRateChargeForASN":{"type":"number","format":"double"}},"xml":{"name":"CreateClient"},"type":"object"},"UpdateClient":{"required":["ID"],"properties":{"ID":{"type":"integer","format":"int32"},"ShortName":{"type":"string","maxLength":30,"minLength":0},"Name":{"type":"string","maxLength":50,"minLength":0},"Code":{"type":"string","maxLength":50,"minLength":0},"BrandName":{"type":"string","maxLength":50,"minLength":0},"ContactName":{"type":"string","maxLength":50,"minLength":0},"ContactNumber":{"type":"string","maxLength":50,"minLength":0},"AddressLine1":{"type":"string","maxLength":50,"minLength":0},"AddressLine2":{"type":"string","maxLength":50,"minLength":0},"AddressLine3":{"type":"string","maxLength":50,"minLength":0},"Town":{"type":"string","maxLength":50,"minLength":0},"County":{"type":"string","maxLength":50,"minLength":0},"Postcode":{"type":"string","maxLength":50,"minLength":0},"CountryId":{"type":"integer","format":"int32"},"AdditionalInfo":{"type":"string","maxLength":50,"minLength":0},"ContactEmail":{"type":"string","maxLength":100,"minLength":0},"OnStop":{"type":"boolean"},"AccountingIntegrationType":{"type":"string","maxLength":100,"minLength":0},"CustomerRegistrationNumber":{"type":"string","maxLength":8,"minLength":0},"VATNumber":{"type":"string","maxLength":50,"minLength":0},"EORINumber":{"type":"string","maxLength":50,"minLength":0},"NIREORINumber":{"type":"string","maxLength":50,"minLength":0},"IOSSNumber":{"type":"string","maxLength":50,"minLength":0},"PPINumber":{"type":"string","maxLength":50,"minLength":0},"UKIMSNumber":{"type":"string","maxLength":50,"minLength":0},"VOECNumber":{"type":"string","maxLength":10,"minLength":0},"VatExempt":{"type":"boolean"},"DefaultCustomsDescription":{"type":"string","maxLength":50,"minLength":0},"DefaultMIDCode":{"type":"string","maxLength":30,"minLength":0},"CountryOfManufactureId":{"type":"integer","format":"int32"},"DefaultCommodityCode":{"type":"string","maxLength":50,"minLength":0},"DefaultMaterial":{"type":"string","maxLength":50,"minLength":0},"PickingCalculationType":{"type":"string"},"TieredPricingInvoiceFrequency":{"type":"string"},"StandardPickingCost":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"AdditionalPickingCostPerItem":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"NumberOfItemsIncludedInStandardPick":{"type":"integer","format":"int32","maximum":100,"minimum":1},"EnableCartonPickingCost":{"type":"boolean"},"StandardCartonPickingCost":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"AdditionalPickingCostPerCarton":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"EnablePalletPickingCost":{"type":"boolean"},"StandardPalletPickingCost":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"AdditionalPickingCostPerPallet":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"PickingSKUCost":{"type":"number","format":"double","maximum":5000.0,"minimum":0.0},"PercentageOfOrderValuePickingCost":{"type":"number","format":"double","maximum":100,"minimum":0},"ReturnsCostFirstItem":{"type":"number","format":"double","maximum":5000.0,"minimum":0.0},"ReturnsCostAdditionalItem":{"type":"number","format":"double","maximum":5000.0,"minimum":0.0},"DefaultPackagingFee":{"type":"number","format":"double"},"PickingCostPerCBM":{"type":"number","format":"double","maximum":100.0,"minimum":0.0},"PerOrderAdminFee":{"type":"number","format":"double"},"StockManagementFee":{"type":"number","format":"double","maximum":500000.0,"minimum":0.0},"VolumetricStorageFee":{"type":"number","format":"double","maximum":5000.0,"minimum":0.0},"VolumetricStorageFrequency":{"type":"string"},"StorageType":{"type":"string"},"AutoCalculateVolumetricStorage":{"type":"boolean"},"GoodsInCostCarton":{"type":"number","format":"double"},"GoodsInCostPallet":{"type":"number","format":"double"},"GoodsInCost20ftContainer":{"type":"number","format":"double"},"GoodsInCost40ftContainer":{"type":"number","format":"double"},"GoodsInCost40ftContainerHC":{"type":"number","format":"double"},"GoodsInCost45ftContainer":{"type":"number","format":"double"},"GoodsInCost45ftContainerHC":{"type":"number","format":"double"},"GoodsInCostSku":{"type":"number","format":"double"},"GoodsInCostUnit":{"type":"number","format":"double"},"AdminChargePerASN":{"type":"number","format":"double"},"HourRateChargeForASN":{"type":"number","format":"double"}},"xml":{"name":"UpdateClient"},"type":"object"},"SubClient":{"properties":{"ID":{"type":"integer","format":"int32"},"Name":{"type":"string"},"ShortName":{"type":"string"},"Code":{"type":"string"},"Master":{"type":"boolean"}},"xml":{"name":"SubClient"},"type":"object"},"AddSubClient":{"properties":{"Name":{"type":"string"},"ShortName":{"type":"string"},"Code":{"type":"string"}},"xml":{"name":"AddSubClient"},"type":"object"},"CourierService":{"properties":{"CourierServiceTypeId":{"type":"integer","format":"int32"},"Name":{"type":"string","maxLength":60,"minLength":0},"TrackingURL":{"type":"string","maxLength":200,"minLength":0},"ActiveB":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"CourierService"},"type":"object"},"CourierServiceType":{"properties":{"Name":{"type":"string"},"Active":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"CourierServiceType"},"type":"object"},"ExternalCourierServiceName":{"properties":{"CourierServiceId":{"type":"integer","format":"int32"},"Source":{"type":"string"},"Name":{"type":"string"},"ExtraCode1":{"type":"string"},"ExtraCode2":{"type":"string"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ExternalCourierServiceName"},"type":"object"},"OrderStatus":{"properties":{"Name":{"type":"string"},"ExternalName":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderStatus"},"type":"object"},"OrderDocumentType":{"properties":{"Name":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderDocumentType"},"type":"object"},"OrderShipmentTrackingEvent":{"properties":{"OrderShipmentId":{"type":"integer","format":"int32"},"OrderShipment":{"$ref":"#/definitions/OrderShipment"},"TrackingStatusId":{"type":"integer","format":"int32"},"CourierCustomerDescription":{"type":"string"},"CourierExternalDescription":{"type":"string"},"CourierTrackingStageCode":{"type":"string"},"CourierTrackingEventId":{"type":"string"},"CourierTimeStamp":{"type":"string","format":"date-time"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderShipmentTrackingEvent"},"type":"object"},"OrderShipment":{"properties":{"OrderId":{"type":"integer","format":"int32"},"OrderDocumentId":{"type":"integer","format":"int32"},"DangerousDocumentId":{"type":"integer","format":"int32"},"CourierType":{"type":"string"},"AccountId":{"type":"integer","format":"int32"},"Number":{"type":"string"},"ExtraBool1":{"type":"boolean"},"ExtraBool2":{"type":"boolean"},"ExtraInt1":{"type":"integer","format":"int32"},"ExtraInt2":{"type":"integer","format":"int32"},"ExtraString1":{"type":"string"},"ExtraString2":{"type":"string"},"CommercialInvoiceId":{"type":"integer","format":"int32"},"ReturnLabelId":{"type":"integer","format":"int32"},"ReturnLabelBarcode":{"type":"string"},"DownloadTrackingEvents":{"type":"boolean"},"RequiresManifesting":{"type":"boolean"},"Manifested":{"type":"boolean"},"ShipmentDate":{"type":"string","format":"date-time"},"LabelURL":{"type":"string"},"ParcelNumbers":{"items":{"type":"string"},"readOnly":true,"type":"array"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderShipment"},"type":"object"},"NewOrderWithItems":{"properties":{"OrderItems":{"items":{"$ref":"#/definitions/NewOrderItem"},"xml":{"name":"NewOrderItem","wrapped":true},"type":"array"},"OrderNameValues":{"items":{"$ref":"#/definitions/NewOrderNameValue"},"xml":{"name":"NewOrderNameValue","wrapped":true},"type":"array"},"Tags":{"type":"string"},"ConnectAction":{"$ref":"#/definitions/NewOrderConnectAction"},"OrderNumber":{"type":"string"},"ExternalOrderReference":{"type":"string"},"Title":{"type":"string"},"CompanyName":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"Address3":{"type":"string"},"Town":{"type":"string"},"County":{"type":"string"},"PostCode":{"type":"string"},"Country":{"type":"string"},"CountryId":{"type":"integer","format":"int32"},"Email":{"type":"string"},"Phone":{"type":"string"},"Mobile":{"type":"string"},"CourierService":{"type":"string"},"CourierServiceId":{"type":"integer","format":"int32"},"Channel":{"type":"string"},"ChannelId":{"type":"integer","format":"int32"},"Warehouse":{"type":"string"},"WarehouseId":{"type":"integer","format":"int32"},"Currency":{"type":"string"},"CurrencyId":{"type":"integer","format":"int32"},"DeliveryDate":{"type":"string","format":"date-time"},"DespatchDate":{"type":"string","format":"date-time"},"RequiredDeliveryDate":{"type":"string","format":"date-time"},"RequiredDespatchDate":{"type":"string","format":"date-time"},"Comments":{"type":"string"},"DeliveryNotes":{"type":"string"},"GiftMessages":{"type":"string"},"VATNumber":{"type":"string"},"EORINumber":{"type":"string"},"PIDNumber":{"type":"string"},"UKIMSNumber":{"type":"string"},"RFCNumber":{"type":"string"},"IOSSNumber":{"type":"string"},"OrderValue":{"type":"number","format":"double"},"ShippingTotalExVat":{"type":"number","format":"double"},"ShippingTotalVat":{"type":"number","format":"double"},"DiscountTotalExVat":{"type":"number","format":"double"},"DiscountTotalVat":{"type":"number","format":"double"},"TotalVat":{"type":"number","format":"double"},"ClientId":{"type":"integer","format":"int32"},"NumberOfParcels":{"type":"integer","format":"int32"},"CashOnDelivery":{"$ref":"#/definitions/CashOnDelivery"},"RecipientType":{"type":"string"},"NationalAddressField":{"type":"string"}},"xml":{"name":"NewOrderWithItems"},"type":"object"},"NewOrderItem":{"properties":{"SKU":{"type":"string"},"ProductId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"Details":{"type":"string"},"UnitPrice":{"type":"number","format":"double"},"UnitPriceVat":{"type":"number","format":"double"},"Discount":{"type":"number","format":"double"},"OrderItemNameValues":{"items":{"$ref":"#/definitions/NewOrderItemNameValue"},"xml":{"name":"NewOrderItemNameValue","wrapped":true},"type":"array"},"WarehouseId":{"type":"integer","format":"int32"},"RequestedSerialNo":{"type":"string"},"RequestedBatchNo":{"type":"string"},"RequestedBBEDate":{"type":"string"}},"xml":{"name":"NewOrderItem"},"type":"object"},"NewOrderNameValue":{"properties":{"Name":{"type":"string"},"Value":{"type":"string"}},"xml":{"name":"NewOrderNameValue"},"type":"object"},"NewOrderConnectAction":{"properties":{"Type":{"type":"string"},"SourceOrderId":{"type":"string"},"Complete":{"type":"boolean"},"AccountId":{"type":"integer","format":"int32"},"ExtraCode1":{"type":"string"},"ExtraCode2":{"type":"string"},"ExtraCode3":{"type":"string"},"ExtraCode4":{"type":"string"},"ExtraCode5":{"type":"string"},"ExtraFlag1":{"type":"boolean"},"ExtraFlag2":{"type":"boolean"},"Messages":{"type":"string"},"ExtraDate1":{"type":"string","format":"date-time"}},"xml":{"name":"NewOrderConnectAction"},"type":"object"},"CashOnDelivery":{"properties":{"Amount":{"type":"number","format":"double"},"CurrencyCode":{"type":"string"}},"xml":{"name":"CashOnDelivery"},"type":"object"},"NewOrderItemNameValue":{"properties":{"Name":{"type":"string"},"Value":{"type":"string"}},"xml":{"name":"NewOrderItemNameValue"},"type":"object"},"NewOrderResult":{"properties":{"OrderId":{"type":"integer","format":"int32"},"DropShipOrderId":{"type":"integer","format":"int32"},"OrderNumber":{"type":"string"},"Success":{"type":"boolean"},"OrderStatusId":{"type":"integer","format":"int32"},"OrderStatus":{"type":"string"},"Message":{"type":"string"},"OrderItems":{"items":{"$ref":"#/definitions/NewOrderResultItems"},"xml":{"name":"NewOrderResultItems","wrapped":true},"type":"array"}},"xml":{"name":"NewOrderResult"},"type":"object"},"NewOrderResultItems":{"properties":{"SKU":{"type":"string"},"ID":{"type":"integer","format":"int32"}},"xml":{"name":"NewOrderResultItems"},"type":"object"},"NewOrder":{"properties":{"OrderNumber":{"type":"string"},"ExternalOrderReference":{"type":"string"},"Title":{"type":"string"},"CompanyName":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"Address3":{"type":"string"},"Town":{"type":"string"},"County":{"type":"string"},"PostCode":{"type":"string"},"Country":{"type":"string"},"CountryId":{"type":"integer","format":"int32"},"Email":{"type":"string"},"Phone":{"type":"string"},"Mobile":{"type":"string"},"CourierService":{"type":"string"},"CourierServiceId":{"type":"integer","format":"int32"},"Channel":{"type":"string"},"ChannelId":{"type":"integer","format":"int32"},"Warehouse":{"type":"string"},"WarehouseId":{"type":"integer","format":"int32"},"Currency":{"type":"string"},"CurrencyId":{"type":"integer","format":"int32"},"DeliveryDate":{"type":"string","format":"date-time"},"DespatchDate":{"type":"string","format":"date-time"},"RequiredDeliveryDate":{"type":"string","format":"date-time"},"RequiredDespatchDate":{"type":"string","format":"date-time"},"Comments":{"type":"string"},"DeliveryNotes":{"type":"string"},"GiftMessages":{"type":"string"},"VATNumber":{"type":"string"},"EORINumber":{"type":"string"},"PIDNumber":{"type":"string"},"UKIMSNumber":{"type":"string"},"RFCNumber":{"type":"string"},"IOSSNumber":{"type":"string"},"OrderValue":{"type":"number","format":"double"},"ShippingTotalExVat":{"type":"number","format":"double"},"ShippingTotalVat":{"type":"number","format":"double"},"DiscountTotalExVat":{"type":"number","format":"double"},"DiscountTotalVat":{"type":"number","format":"double"},"TotalVat":{"type":"number","format":"double"},"ClientId":{"type":"integer","format":"int32"},"NumberOfParcels":{"type":"integer","format":"int32"},"CashOnDelivery":{"$ref":"#/definitions/CashOnDelivery"},"RecipientType":{"type":"string"},"NationalAddressField":{"type":"string"}},"xml":{"name":"NewOrder"},"type":"object"},"OrderComment":{"properties":{"OrderId":{"type":"integer","format":"int32"},"OrderStatusId":{"type":"integer","format":"int32"},"Comment":{"readOnly":true,"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderComment"},"type":"object"},"NewOrderComment":{"properties":{"Comment":{"type":"string"},"Admin":{"type":"boolean"}},"xml":{"name":"NewOrderComment"},"type":"object"},"OrderSplit":{"properties":{"OrderId":{"type":"integer","format":"int32"},"Order":{"$ref":"#/definitions/Order"},"SplitOrderId":{"type":"integer","format":"int32"},"SplitOrder":{"$ref":"#/definitions/Order"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderSplit"},"type":"object"},"OrderDocument":{"properties":{"OrderId":{"type":"integer","format":"int32"},"OrderDocumentTypeId":{"type":"integer","format":"int32"},"FileName":{"type":"string"},"Comments":{"type":"string"},"ContentType":{"type":"string"},"PaperSize":{"type":"string"},"PrintWithOrder":{"type":"boolean"},"Printed":{"type":"boolean"},"Scanned":{"type":"boolean"},"DangerousFile":{"type":"boolean"},"DateDetected":{"type":"string","format":"date-time"},"Base64Data":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderDocument"},"type":"object"},"NewOrderDocument":{"properties":{"Base64Data":{"type":"string"},"FileName":{"type":"string"},"Comment":{"type":"string"},"OrderDocumentTypeId":{"type":"integer","format":"int32"},"OrderDocumentPaperSize":{"type":"string"}},"xml":{"name":"NewOrderDocument"},"type":"object"},"BoxPackingListResponse":{"properties":{"OrderId":{"type":"integer","format":"int32"},"OrderNumber":{"type":"string"},"ExternalOrderReference":{"type":"string"},"Boxes":{"items":{"$ref":"#/definitions/BoxPackingListBox"},"xml":{"name":"BoxPackingListBox","wrapped":true},"type":"array"}},"xml":{"name":"BoxPackingListResponse"},"type":"object"},"BoxPackingListBox":{"properties":{"BoxNumber":{"type":"integer","format":"int32"},"BoxIdentifier":{"type":"string"},"Height":{"type":"number","format":"double"},"Length":{"type":"number","format":"double"},"Depth":{"type":"number","format":"double"},"Weight":{"type":"number","format":"double"},"Items":{"items":{"$ref":"#/definitions/BoxPackingListItem"},"xml":{"name":"BoxPackingListItem","wrapped":true},"type":"array"}},"xml":{"name":"BoxPackingListBox"},"type":"object"},"BoxPackingListItem":{"properties":{"SKU":{"type":"string"},"Name":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"BatchNumber":{"type":"string"},"SerialNumber":{"type":"string"},"SSCCNumber":{"type":"string"}},"xml":{"name":"BoxPackingListItem"},"type":"object"},"NewOrderShipment":{"properties":{"Number":{"type":"string"},"Labels":{"items":{"$ref":"#/definitions/NewOrderDocument"},"xml":{"name":"NewOrderDocument","wrapped":true},"type":"array"}},"xml":{"name":"NewOrderShipment"},"type":"object"},"ShipmentResult":{"properties":{"Shipments":{"items":{"$ref":"#/definitions/OrderShipment"},"xml":{"name":"OrderShipment","wrapped":true},"type":"array"},"ID":{"type":"integer","format":"int32"},"Success":{"type":"boolean"},"SensitiveData":{"type":"string"},"Message":{"type":"string"},"WarningMessage":{"type":"string"},"AllocatedFromReplen":{"type":"boolean"}},"xml":{"name":"ShipmentResult"},"type":"object"},"OrderAwaitingAction":{"properties":{"OrderId":{"type":"integer","format":"int32"},"Type":{"type":"string"},"SourceOrderId":{"type":"string"},"Complete":{"type":"boolean"},"AccountId":{"type":"integer","format":"int32"},"ExtraCode1":{"type":"string"},"ExtraCode2":{"type":"string"},"ExtraCode3":{"type":"string"},"ExtraCode4":{"type":"string"},"ExtraCode5":{"type":"string"},"ExtraFlag1":{"type":"boolean"},"ExtraFlag2":{"type":"boolean"},"Messages":{"type":"string"},"ExtraDate1":{"type":"string","format":"date-time"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderAwaitingAction"},"type":"object"},"ProductInLocation":{"properties":{"LocationId":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"BestBefore":{"type":"string","format":"date-time"},"BatchNo":{"type":"string","maxLength":100,"minLength":0},"SerialNo":{"type":"string"},"InventoryItemId":{"type":"integer","format":"int32"},"Type":{"type":"string"},"StorageItemId":{"type":"integer","format":"int32"},"OrderId":{"type":"integer","format":"int32"},"OrderItemId":{"type":"integer","format":"int32"},"Despatched":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductInLocation"},"type":"object"},"BarcodeVerifiedOrderItem":{"properties":{"OrderItemId":{"type":"integer","format":"int32"},"ProductInLocationId":{"type":"integer","format":"int32"},"OrderId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"ManuallyConfirmed":{"type":"boolean"},"Barcode":{"type":"string"},"BatchNo":{"type":"string","maxLength":100,"minLength":0},"SerialNo":{"type":"string"},"ExpiryDate":{"type":"string","format":"date-time"},"MobileApp":{"type":"boolean"},"BoxNumber":{"type":"integer","format":"int32"},"BoxIdentifier":{"type":"string"},"SSCCNumber":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"BarcodeVerifiedOrderItem"},"type":"object"},"OrderQuery":{"properties":{"OrderId":{"type":"integer","format":"int32"},"QueryTypeId":{"type":"integer","format":"int32"},"QueryStatusId":{"type":"integer","format":"int32"},"UsersInvolved":{"type":"string"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderQuery"},"type":"object"},"OrderQueryComment":{"properties":{"OrderQueryId":{"type":"integer","format":"int32"},"Comment":{"type":"string"},"Admin":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderQueryComment"},"type":"object"},"SplitOrderOnOrderItems":{"properties":{"QuantityToDespatch":{"type":"integer","format":"int32"},"OrderItemId":{"type":"integer","format":"int32"}},"xml":{"name":"SplitOrderOnOrderItems"},"type":"object"},"Address":{"required":["FirstName","Address1","PostCode","CountryId"],"properties":{"Title":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"CompanyName":{"type":"string"},"Address1":{"type":"string"},"Address2":{"type":"string"},"Address3":{"type":"string"},"Town":{"type":"string"},"County":{"type":"string"},"PostCode":{"type":"string"},"Phone":{"type":"string"},"Mobile":{"type":"string"},"Email":{"type":"string"},"CountryId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"OrderId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Address"},"type":"object"},"OrderRule":{"properties":{"Action":{"type":"string"},"ConditionType":{"type":"string"},"OrderRuleConditions":{"items":{"$ref":"#/definitions/OrderRuleCondition"},"xml":{"name":"OrderRuleCondition","wrapped":true},"type":"array"},"Param":{"type":"string"},"Active":{"type":"boolean"},"OverwriteExisting":{"type":"boolean"},"Priority":{"type":"integer","format":"int32","maximum":100,"minimum":1},"Comments":{"type":"string"},"ChannelId":{"type":"integer","format":"int32"},"WarehouseId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderRule"},"type":"object"},"OrderRuleCondition":{"properties":{"OrderRuleId":{"type":"integer","format":"int32"},"Field":{"type":"string"},"Operator":{"type":"string"},"Value":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"OrderRuleCondition"},"type":"object"},"AddOrderRuleConditionRequest":{"properties":{"Field":{"type":"string"},"Operator":{"type":"string"},"Value":{"type":"string"}},"xml":{"name":"AddOrderRuleConditionRequest"},"type":"object"},"OrderRuleConditionOptions":{"properties":{"ConditionTypes":{"items":{"type":"string"},"type":"array"},"Fields":{"items":{"type":"string"},"type":"array"},"Operators":{"items":{"type":"string"},"type":"array"}},"xml":{"name":"OrderRuleConditionOptions"},"type":"object"},"RunOrderRulesResult":{"properties":{"OrderResults":{"items":{"$ref":"#/definitions/OrderResult"},"xml":{"name":"OrderResult","wrapped":true},"type":"array"},"SplitOrder":{"readOnly":true,"type":"boolean"},"ID":{"type":"integer","format":"int32"},"Success":{"type":"boolean"},"SensitiveData":{"type":"string"},"Message":{"type":"string"},"WarningMessage":{"type":"string"},"AllocatedFromReplen":{"type":"boolean"}},"xml":{"name":"RunOrderRulesResult"},"type":"object"},"OrderResult":{"properties":{"Status":{"$ref":"#/definitions/OrderStatus"},"Error":{"$ref":"#/definitions/OrderError"},"OrderNumber":{"type":"string"},"TrackingNumber":{"type":"string"},"OrderId":{"type":"integer","format":"int32"},"ExtOrderId":{"type":"integer","format":"int32"},"BackOrder":{"type":"boolean"},"OrderItems":{"items":{"$ref":"#/definitions/OrderResultItems"},"xml":{"name":"OrderResultItems","wrapped":true},"type":"array"}},"xml":{"name":"OrderResult"},"type":"object"},"OrderError":{"properties":{"ErrorCode":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48]},"Error":{"type":"string"}},"xml":{"name":"OrderError"},"type":"object"},"OrderResultItems":{"properties":{"SKU":{"type":"string"},"ID":{"type":"integer","format":"int32"}},"xml":{"name":"OrderResultItems"},"type":"object"},"Product":{"required":["SKU","Weight"],"properties":{"SKU":{"type":"string","maxLength":75,"minLength":0},"Name":{"type":"string","maxLength":99,"minLength":0},"PalletSizes":{"type":"string"},"PackingInstructions":{"type":"string","maxLength":250,"minLength":0},"Description":{"type":"string"},"CustomsDescription":{"type":"string","maxLength":50,"minLength":0},"MIDCode":{"type":"string","maxLength":30,"minLength":0},"CountryOfManufactureId":{"type":"integer","format":"int32"},"CountryOfManufacture":{"$ref":"#/definitions/Country"},"EAN":{"type":"string"},"UPC":{"type":"string"},"LowStockAlertLevel":{"type":"integer","format":"int32"},"Weight":{"type":"number","format":"double","maximum":100000.0,"minimum":0.0},"Height":{"type":"number","format":"double"},"Width":{"type":"number","format":"double"},"Depth":{"type":"number","format":"double"},"Volume":{"type":"number","format":"double"},"BackOrder":{"type":"boolean"},"Bundle":{"type":"boolean"},"DisCont":{"type":"boolean"},"Price":{"type":"number","format":"double"},"CostPrice":{"type":"number","format":"double"},"VatExempt":{"type":"boolean"},"AdditionalParcelsRequired":{"type":"integer","format":"int32","maximum":1000,"minimum":0},"UnitsPerParcel":{"type":"number","format":"double","maximum":1000000,"minimum":0},"HasBatchNumber":{"type":"boolean"},"LogBatchInbound":{"type":"boolean"},"LogBatchOutbound":{"type":"boolean"},"HasSerialNumber":{"type":"boolean"},"LogSerialInbound":{"type":"boolean"},"LogSerialOutbound":{"type":"boolean"},"HasExpiryDate":{"type":"boolean"},"LogExpiryDateInbound":{"type":"boolean"},"LogExpiryDateOutbound":{"type":"boolean"},"BestBeforeDateWarningPeriodDays":{"type":"integer","format":"int32","maximum":365,"minimum":0},"CommodityCode":{"$ref":"#/definitions/CommodityCode"},"HandlingTime":{"type":"integer","format":"int32","maximum":365,"minimum":0},"ToteCapacity":{"type":"integer","format":"int32"},"UnNumber":{"type":"string","maxLength":4,"minLength":0},"ImageURL":{"type":"string"},"SyncStockFrom":{"type":"string","format":"date-time"},"ProductHazardousGoods":{"$ref":"#/definitions/ProductHazardousGoods"},"ProductPurchasingSettings":{"$ref":"#/definitions/ProductPurchasingSettings"},"ProductGrowthRates":{"items":{"$ref":"#/definitions/ProductGrowthRates"},"xml":{"name":"ProductGrowthRates","wrapped":true},"type":"array"},"OrderItems":{"items":{"$ref":"#/definitions/OrderItem"},"xml":{"name":"OrderItem","wrapped":true},"type":"array"},"Subscription":{"type":"boolean"},"SubscriptionLength":{"type":"integer","format":"int32"},"SubscriptionFrequency":{"type":"string"},"ProductInCategories":{"items":{"$ref":"#/definitions/ProductInCategory"},"xml":{"name":"ProductInCategory","wrapped":true},"type":"array"},"ProductPrices":{"items":{"$ref":"#/definitions/ProductPrice"},"xml":{"name":"ProductPrice","wrapped":true},"type":"array"},"ProductSuppliers":{"items":{"$ref":"#/definitions/ProductInSupplier"},"xml":{"name":"ProductInSupplier","wrapped":true},"type":"array"},"ProductCustomFields":{"items":{"$ref":"#/definitions/ProductCustomField"},"xml":{"name":"ProductCustomField","wrapped":true},"type":"array"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Product"},"type":"object"},"CommodityCode":{"properties":{"Code":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"CommodityCode"},"type":"object"},"ProductHazardousGoods":{"properties":{"ProductID":{"type":"integer","format":"int32","default":0},"HazardousUnNumber":{"type":"string","default":""},"HazardousUnNumberPrefixed":{"type":"string","default":""},"HazardousClass":{"type":"string","default":""},"HazardousProperShippingName":{"type":"string","default":""},"HazardousPackingCode":{"type":"string","default":""},"HazardousTunnelCode":{"type":"string","default":""},"HazardousLimitedQuantity":{"type":"string","default":""},"HazardousFullProperShippingCode":{"type":"string","default":""},"HazardousContentId":{"type":"string","default":""},"HazardousNotes":{"type":"string","default":""},"LitresPerUnit":{"type":"number","format":"double","default":0},"PackagingDescription":{"type":"string","default":""},"PackagingInstructions":{"type":"string","default":""},"FreezingPoint":{"type":"number","format":"double","default":0},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductHazardousGoods"},"type":"object"},"ProductPurchasingSettings":{"properties":{"DefaultMinOrderQty":{"type":"integer","format":"int32"},"DefaultMaxOrderQty":{"type":"integer","format":"int32"},"DefaultOrderQty":{"type":"integer","format":"int32"},"IncludeLinkedItems":{"type":"boolean"},"ExcludeFromForecast":{"type":"boolean"},"ForecastPeriodDays":{"type":"integer","format":"int32"},"LeadTimeDays":{"type":"integer","format":"int32"},"AvgDailyConsumption":{"type":"integer","format":"int32"}},"xml":{"name":"ProductPurchasingSettings"},"type":"object"},"ProductGrowthRates":{"properties":{"ProductId":{"type":"integer","format":"int32"},"Product":{"$ref":"#/definitions/Product"},"WeekNo":{"type":"integer","format":"int32"},"SalesGrowth":{"type":"number","format":"double"},"SeasonalGrowth":{"type":"number","format":"double"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductGrowthRates"},"type":"object"},"ProductInCategory":{"properties":{"ProductId":{"type":"integer","format":"int32"},"ProductCategoryId":{"type":"integer","format":"int32"},"ProductCategory":{"$ref":"#/definitions/ProductCategory"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductInCategory"},"type":"object"},"ProductPrice":{"properties":{"ProductId":{"type":"integer","format":"int32"},"Price":{"type":"number","format":"double"},"ProductPriceTypeId":{"type":"integer","format":"int32"},"ProductPriceType":{"$ref":"#/definitions/ProductPriceType"},"CurrencyId":{"type":"integer","format":"int32"},"Currency":{"$ref":"#/definitions/Currency"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductPrice"},"type":"object"},"ProductInSupplier":{"properties":{"ProductId":{"type":"integer","format":"int32"},"ProductSupplierId":{"type":"integer","format":"int32"},"ProductSupplier":{"$ref":"#/definitions/ProductSupplier"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductInSupplier"},"type":"object"},"ProductCustomField":{"properties":{"ProductId":{"type":"integer","format":"int32"},"CustomField":{"type":"string"},"Name":{"type":"string"},"Value":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductCustomField"},"type":"object"},"ProductCategory":{"properties":{"Name":{"type":"string"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductCategory"},"type":"object"},"ProductPriceType":{"properties":{"Name":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductPriceType"},"type":"object"},"ProductSupplier":{"properties":{"Name":{"type":"string"},"ContactName":{"type":"string"},"ContactNumber":{"type":"string"},"AddressLine1":{"type":"string"},"AddressLine2":{"type":"string"},"AddressLine3":{"type":"string"},"Town":{"type":"string"},"County":{"type":"string"},"Postcode":{"type":"string"},"CountryId":{"type":"integer","format":"int32"},"Country":{"$ref":"#/definitions/Country"},"ContactEmail":{"type":"string"},"Active":{"type":"boolean"},"Code":{"type":"string"},"CurrencyId":{"type":"integer","format":"int32"},"Currency":{"$ref":"#/definitions/Currency"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductSupplier"},"type":"object"},"NewProductResult":{"properties":{"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"Name":{"type":"string"},"Success":{"type":"boolean"},"Message":{"type":"string"}},"xml":{"name":"NewProductResult"},"type":"object"},"NewProductPrice":{"properties":{"ProductId":{"type":"integer","format":"int32"},"CurrencyCode":{"type":"string"},"CurrencyId":{"type":"integer","format":"int32"},"PriceTypeId":{"type":"integer","format":"int32"},"PriceType":{"type":"string"},"Price":{"type":"number","format":"double"}},"xml":{"name":"NewProductPrice"},"type":"object"},"Bundle":{"properties":{"SKU":{"type":"string"},"Name":{"type":"string"},"PackingInstructions":{"type":"string"},"Components":{"items":{"$ref":"#/definitions/BundleItem"},"xml":{"name":"BundleItem","wrapped":true},"type":"array"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Bundle"},"type":"object"},"BundleItem":{"properties":{"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"Product":{"$ref":"#/definitions/Product"},"Quantity":{"type":"integer","format":"int32"},"PercentageOfSalesValue":{"type":"number","format":"double"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"BundleItem"},"type":"object"},"StockFlow":{"properties":{"ProductId":{"type":"integer","format":"int32"},"WarehouseId":{"type":"integer","format":"int32"},"StockLevel":{"type":"integer","format":"int32"},"Allocated":{"type":"integer","format":"int32"},"OnHand":{"type":"integer","format":"int32"},"OffHand":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"Flow":{"type":"string"},"Reason":{"type":"string"},"BestBefore":{"type":"string","format":"date-time"},"BatchNo":{"type":"string","maxLength":100,"minLength":0},"SerialNo":{"type":"string"},"Tags":{"type":"string"},"StorageItemId":{"type":"integer","format":"int32"},"ParentStorageItemId":{"type":"integer","format":"int32"},"OrderId":{"type":"integer","format":"int32"},"StockFlowDetails":{"items":{"$ref":"#/definitions/StockFlowDetail"},"xml":{"name":"StockFlowDetail","wrapped":true},"type":"array"},"SKU":{"readOnly":true,"type":"string"},"WarehouseName":{"readOnly":true,"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"StockFlow"},"type":"object"},"StockFlowDetail":{"properties":{"LocationId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"BestBefore":{"type":"string","format":"date-time"},"BatchNo":{"type":"string","maxLength":100,"minLength":0},"SerialNo":{"type":"string"},"Location":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"StockFlowDetail"},"type":"object"},"ProductContainer":{"properties":{"ProductId":{"type":"integer","format":"int32"},"Barcode":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"Height":{"type":"number","format":"double"},"Width":{"type":"number","format":"double"},"Depth":{"type":"number","format":"double"},"UseCartonAsBoxOnNewBoxPackingScreen":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductContainer"},"type":"object"},"ProductAltCode":{"properties":{"ProductId":{"type":"integer","format":"int32"},"Type":{"type":"string"},"SKU":{"type":"string"},"Message":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ProductAltCode"},"type":"object"},"InventoryItem":{"properties":{"ProductId":{"type":"integer","format":"int32"},"StockLevel":{"type":"integer","format":"int32"},"Allocated":{"type":"integer","format":"int32"},"OnHand":{"type":"integer","format":"int32"},"OffHand":{"type":"integer","format":"int32"},"AwaitingReplen":{"type":"integer","format":"int32"},"OnOrder":{"type":"integer","format":"int32"},"RequiredByBackOrder":{"type":"integer","format":"int32"},"InQuarantine":{"type":"integer","format":"int32"},"InTransit":{"type":"integer","format":"int32"},"InTransition":{"type":"integer","format":"int32"},"Scrapped":{"type":"integer","format":"int32"},"SKU":{"readOnly":true,"type":"string"},"WarehouseId":{"type":"integer","format":"int32"},"LocationId":{"type":"integer","format":"int32"},"Breakdown":{"items":{"$ref":"#/definitions/StockLevelBreakdown"},"xml":{"name":"StockLevelBreakdown","wrapped":true},"type":"array"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"InventoryItem"},"type":"object"},"StockLevelBreakdown":{"properties":{"Quantity":{"type":"integer","format":"int32"},"BatchNo":{"type":"string"},"SerialNo":{"type":"string"},"BestBefore":{"type":"string"},"Type":{"type":"string"}},"xml":{"name":"StockLevelBreakdown"},"type":"object"},"BulkInventoryItem":{"properties":{"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"},"ProductId":{"type":"integer","format":"int32"},"StockLevel":{"type":"integer","format":"int32"},"Allocated":{"type":"integer","format":"int32"},"OnHand":{"type":"integer","format":"int32"},"OffHand":{"type":"integer","format":"int32"},"AwaitingReplen":{"type":"integer","format":"int32"},"OnOrder":{"type":"integer","format":"int32"},"RequiredByBackOrder":{"type":"integer","format":"int32"},"InQuarantine":{"type":"integer","format":"int32"},"InTransit":{"type":"integer","format":"int32"},"InTransition":{"type":"integer","format":"int32"},"Scrapped":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"WarehouseId":{"type":"integer","format":"int32"},"LocationId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"ClientName":{"type":"string"},"WarehouseName":{"type":"string"},"Breakdown":{"items":{"$ref":"#/definitions/StockLevelBreakdown"},"xml":{"name":"StockLevelBreakdown","wrapped":true},"type":"array"}},"xml":{"name":"BulkInventoryItem"},"type":"object"},"StockLevel":{"properties":{"ProductId":{"type":"integer","format":"int32"},"WarehouseId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"Level":{"type":"integer","format":"int32"},"TotalStockLevel":{"type":"integer","format":"int32"},"PreOrderable":{"type":"boolean"},"Bundle":{"type":"boolean"},"LowStockLevel":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"Breakdown":{"items":{"$ref":"#/definitions/StockLevelBreakdown"},"xml":{"name":"StockLevelBreakdown","wrapped":true},"type":"array"}},"xml":{"name":"StockLevel"},"type":"object"},"InventoryPreOrderBreakdown":{"properties":{"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"StockLevel":{"type":"integer","format":"int32"},"OutOfStock":{"type":"boolean"},"PreOrderable":{"type":"boolean"},"WarehouseId":{"type":"integer","format":"int32"},"OnOrder":{"type":"integer","format":"int32"},"RequiredByBackOrder":{"type":"integer","format":"int32"},"AvailableForPreOrder":{"type":"integer","format":"int32"},"ETAForNewOrders":{"type":"string","format":"date-time"},"Breakdown":{"items":{"$ref":"#/definitions/ASNBreakdown"},"xml":{"name":"ASNBreakdown","wrapped":true},"type":"array"}},"xml":{"name":"InventoryPreOrderBreakdown"},"type":"object"},"ASNBreakdown":{"properties":{"Quantity":{"type":"integer","format":"int32"},"ASNId":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"Reference":{"type":"string"},"Shipped":{"type":"boolean"},"ExpectedDeliveryDate":{"type":"string","format":"date-time"}},"xml":{"name":"ASNBreakdown"},"type":"object"},"BulkOnHandStockUpdate":{"properties":{"SKU":{"type":"string"},"ProductId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"WarehouseId":{"type":"integer","format":"int32"}},"xml":{"name":"BulkOnHandStockUpdate"},"type":"object"},"BulkStockUpdateResult":{"properties":{"Success":{"type":"boolean"},"Message":{"type":"string"},"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"}},"xml":{"name":"BulkStockUpdateResult"},"type":"object"},"ReplenPointResponse":{"properties":{"Id":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"ProductSKU":{"type":"string"},"ProductName":{"type":"string"},"LocationTypeId":{"type":"integer","format":"int32"},"LocationTypeName":{"type":"string"},"Size":{"type":"integer","format":"int32"},"ReplenPoint":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ReplenPointResponse"},"type":"object"},"ReplenPointRequest":{"properties":{"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"LocationTypeId":{"type":"integer","format":"int32"},"LocationType":{"type":"string"},"Size":{"type":"integer","format":"int32"},"ReplenPoint":{"type":"integer","format":"int32"}},"xml":{"name":"ReplenPointRequest"},"type":"object"},"CourierDespatchReportLine":{"properties":{"CourierService":{"type":"string"},"NoOfParcels":{"type":"integer","format":"int32"},"TotalWeight":{"type":"number","format":"double"},"PPILogoId":{"type":"integer","format":"int32"},"Client":{"type":"string"},"Country":{"type":"string"},"Warehouse":{"type":"string"},"AverageWeight":{"readOnly":true,"type":"number","format":"double"}},"xml":{"name":"CourierDespatchReportLine"},"type":"object"},"ProductInLocationExportModel":{"properties":{"Client":{"type":"string"},"Warehouse":{"type":"string"},"Location":{"type":"string"},"Type":{"type":"string"},"LocationType":{"type":"string"},"AllocatedOrder":{"type":"string"},"ProductSKU":{"type":"string"},"ProductName":{"type":"string"},"Quantity":{"type":"string"},"SerialNo":{"type":"string"},"BatchNo":{"type":"string"},"BestBefore":{"type":"string"},"CartonCode":{"type":"string"},"PalletCode":{"type":"string"},"ImageURL":{"type":"string"},"ProductInLocationId":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"}},"xml":{"name":"ProductInLocationExportModel"},"type":"object"},"StockFlowTableRow":{"properties":{"ID":{"type":"integer","format":"int32"},"Client":{"type":"string"},"SKU":{"type":"string"},"Warehouse":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"NewStockLevel":{"type":"integer","format":"int32"},"NewAllocatedLevel":{"type":"integer","format":"int32"},"NewOnHandLevel":{"type":"integer","format":"int32"},"NewOffHandLevel":{"type":"integer","format":"int32"},"Flow":{"type":"string"},"Reason":{"type":"string"},"User":{"type":"string"},"Date":{"type":"string"},"ExtraInfo":{"type":"string"},"CartonCode":{"type":"string"},"PalletCode":{"type":"string"},"ExternalOrderReference":{"type":"string"},"StockFlowDetailRows":{"items":{"$ref":"#/definitions/StockFlowDetailRow"},"xml":{"name":"StockFlowDetailRow","wrapped":true},"type":"array"}},"xml":{"name":"StockFlowTableRow"},"type":"object"},"StockFlowDetailRow":{"properties":{"StockFlowId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"BestBefore":{"type":"string"},"BatchNo":{"type":"string"},"SerialNo":{"type":"string"},"Location":{"type":"string"}},"xml":{"name":"StockFlowDetailRow"},"type":"object"},"ReturnReason":{"properties":{"Name":{"type":"string"},"StockAction":{"type":"string"},"Active":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ReturnReason"},"type":"object"},"Return":{"properties":{"OrderId":{"type":"integer","format":"int32"},"AdvancedExternalReturn":{"type":"boolean"},"Confirmed":{"type":"boolean"},"Exchanged":{"type":"boolean"},"Refunded":{"type":"boolean"},"ExchangedOrderId":{"type":"integer","format":"int32"},"Invoiced":{"type":"boolean"},"Reference":{"type":"string"},"CreatedAt":{"type":"string","format":"date-time"},"ReturnItems":{"items":{"$ref":"#/definitions/ReturnItem"},"xml":{"name":"ReturnItem","wrapped":true},"type":"array"},"ReturnNameValues":{"items":{"$ref":"#/definitions/ReturnNameValue"},"xml":{"name":"ReturnNameValue","wrapped":true},"type":"array"},"OrderNumber":{"readOnly":true,"type":"string"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Return"},"type":"object"},"ReturnItem":{"properties":{"OrderItemId":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"ReturnReasonId":{"type":"integer","format":"int32"},"Action":{"type":"string"},"Comments":{"type":"string"},"ExpiryDate":{"type":"string","format":"date-time"},"BatchNo":{"type":"string"},"SerialNo":{"type":"string"},"ReturnedToStock":{"type":"boolean"},"StockAction":{"type":"string"},"ReturnId":{"type":"integer","format":"int32"},"SKU":{"readOnly":true,"type":"string"},"ReturnReasonName":{"readOnly":true,"type":"string"},"NAME":{"readOnly":true,"type":"string"},"LeftToPutAway":{"readOnly":true,"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ReturnItem"},"type":"object"},"ReturnNameValue":{"properties":{"Name":{"type":"string"},"Value":{"type":"string"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"ReturnNameValue"},"type":"object"},"CreateExternalReturnRequest":{"properties":{"ClientId":{"type":"integer","format":"int32"},"WarehouseId":{"type":"integer","format":"int32"},"Reference":{"type":"string"},"ReturnItems":{"items":{"$ref":"#/definitions/CreateExternalReturnItemRequest"},"xml":{"name":"CreateExternalReturnItemRequest","wrapped":true},"type":"array"},"ExtraFields":{"items":{"$ref":"#/definitions/ExternalReturnNameValue"},"xml":{"name":"ExternalReturnNameValue","wrapped":true},"type":"array"}},"xml":{"name":"CreateExternalReturnRequest"},"type":"object"},"CreateExternalReturnItemRequest":{"properties":{"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"ReturnReasonId":{"type":"integer","format":"int32"},"Action":{"type":"string"},"Comments":{"type":"string"},"BatchNo":{"type":"string"},"SerialNo":{"type":"string"},"ExpiryDate":{"type":"string"}},"xml":{"name":"CreateExternalReturnItemRequest"},"type":"object"},"ExternalReturnNameValue":{"properties":{"Name":{"type":"string"},"Value":{"type":"string"}},"xml":{"name":"ExternalReturnNameValue"},"type":"object"},"ReturnItemAPI":{"properties":{"Quantity":{"type":"integer","format":"int32"},"ReturnReasonId":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"Action":{"type":"string"},"Comments":{"type":"string"},"ReturnPhotos":{"items":{"type":"string"},"type":"array"}},"xml":{"name":"ReturnItemAPI"},"type":"object"},"LocationType":{"required":["Name"],"properties":{"Name":{"type":"string","pattern":"^[^\"'&<>()–]+$"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"LocationType"},"type":"object"},"Location":{"required":["Name"],"properties":{"Name":{"type":"string","pattern":"^[^\"'&<>()–]+$"},"LocationTypeId":{"type":"integer","format":"int32"},"SimpleLocationName":{"type":"string","pattern":"^[^\"'&<>()–]+$"},"PickSequence":{"type":"integer","format":"int32"},"LocationName":{"readOnly":true,"type":"string","pattern":"^[^\"'&<>()–]+$"},"WarehouseId":{"readOnly":true,"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Location"},"type":"object"},"StockMovementDTO":{"properties":{"StockMovementId":{"type":"integer","format":"int32"},"LastUpdatedByUser":{"type":"string"},"LastUpdated":{"type":"string","format":"date-time"},"ProductId":{"type":"integer","format":"int32"},"ProductName":{"type":"string"},"ProductSKU":{"type":"string"},"SourceWarehouseId":{"type":"integer","format":"int32"},"SourceWarehouseName":{"type":"string"},"SourceLocationId":{"type":"integer","format":"int32"},"SourceLocationName":{"type":"string"},"DestinationWarehouseId":{"type":"integer","format":"int32"},"DestinationWarehouseName":{"type":"string"},"DestinationLocationId":{"type":"integer","format":"int32"},"DestinationLocationName":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"OrderId":{"type":"integer","format":"int32"},"OrderItemId":{"type":"integer","format":"int32"},"BestBefore":{"type":"string","format":"date-time"},"BatchNo":{"type":"string"},"SerialNo":{"type":"string"},"Comment":{"type":"string"}},"xml":{"name":"StockMovementDTO"},"type":"object"},"BookStockRequest":{"properties":{"OMSVersion":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"WarehouseId":{"type":"integer","format":"int32"},"LocationId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"Adjustment":{"type":"integer","format":"int32"},"OrderId":{"type":"integer","format":"int32"},"OrderItemId":{"type":"integer","format":"int32"},"ASNId":{"type":"integer","format":"int32"},"Comment":{"type":"string"},"ExpiryDate":{"type":"string","format":"date-time"},"BatchNo":{"type":"string","maxLength":100,"minLength":0},"SerialNo":{"type":"string"},"DestinationWarehouseId":{"type":"integer","format":"int32"},"DestinationLocationId":{"type":"integer","format":"int32"},"KitId":{"type":"integer","format":"int32"}},"xml":{"name":"BookStockRequest"},"type":"object"},"APIWarehouseTransfer":{"properties":{"SourceWarehouseId":{"type":"integer","format":"int32"},"DestinationWarehouseId":{"type":"integer","format":"int32"},"Reference":{"type":"string"},"ExpectedDeliveryDate":{"type":"string","format":"date-time"},"Comments":{"type":"string"},"WarehouseTransferStatus":{"type":"string"},"Items":{"items":{"$ref":"#/definitions/APIWarehouseTransferItem"},"xml":{"name":"APIWarehouseTransferItem","wrapped":true},"type":"array"},"GoodsInType":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"CourierServiceId":{"type":"integer","format":"int32"},"CourierService":{"type":"string"},"ChannelId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"}},"xml":{"name":"APIWarehouseTransfer"},"type":"object"},"APIWarehouseTransferItem":{"properties":{"WarehouseTransferId":{"type":"integer","format":"int32"},"WarehouseTransfer":{"$ref":"#/definitions/APIWarehouseTransfer"},"ProductId":{"type":"integer","format":"int32"},"SKU":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"Complete":{"type":"boolean"}},"xml":{"name":"APIWarehouseTransferItem"},"type":"object"},"ToReturnWarehouseTransfer":{"properties":{"ID":{"type":"integer","format":"int32"},"OrderId":{"type":"integer","format":"int32"},"ASNId":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"},"SourceWarehouse":{"type":"string"},"DestinationWarehouse":{"type":"string"},"SourceWarehouseId":{"type":"integer","format":"int32"},"DestinationWarehouseId":{"type":"integer","format":"int32"},"Reference":{"type":"string"},"ExpectedDeliveryDate":{"type":"string","format":"date-time"},"Comments":{"type":"string"},"WarehouseTransferStatus":{"type":"string"},"Items":{"items":{"$ref":"#/definitions/APIWarehouseTransferItem"},"xml":{"name":"APIWarehouseTransferItem","wrapped":true},"type":"array"},"GoodsInType":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"CourierServiceId":{"type":"integer","format":"int32"},"CourierService":{"type":"string"},"ChannelId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"}},"xml":{"name":"ToReturnWarehouseTransfer"},"type":"object"},"WarehouseTransfer":{"properties":{"SourceWarehouseId":{"type":"integer","format":"int32"},"DestinationWarehouseId":{"type":"integer","format":"int32"},"Reference":{"type":"string"},"ExpectedDeliveryDate":{"type":"string","format":"date-time"},"Comments":{"type":"string"},"WarehouseTransferStatus":{"type":"string"},"Items":{"items":{"$ref":"#/definitions/WarehouseTransferItem"},"xml":{"name":"WarehouseTransferItem","wrapped":true},"type":"array"},"OrderId":{"type":"integer","format":"int32"},"ASNId":{"type":"integer","format":"int32"},"GoodsInType":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"CourierServiceId":{"type":"integer","format":"int32"},"CourierService":{"$ref":"#/definitions/CourierService"},"ChannelId":{"type":"integer","format":"int32"},"ClientId":{"type":"integer","format":"int32"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"WarehouseTransfer"},"type":"object"},"WarehouseTransferItem":{"properties":{"WarehouseTransferId":{"type":"integer","format":"int32"},"ProductId":{"type":"integer","format":"int32"},"Quantity":{"type":"integer","format":"int32"},"Complete":{"type":"boolean"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"WarehouseTransferItem"},"type":"object"},"Zone":{"required":["Name"],"properties":{"Name":{"type":"string","pattern":"^[^\"'&<>()–]+$"},"ID":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time"},"LastUpdatedByUser":{"type":"string"}},"xml":{"name":"Zone"},"type":"object"},"ItemInTote":{"properties":{"SKU":{"type":"string"},"Quantity":{"type":"integer","format":"int32"},"Width":{"type":"number","format":"double"},"Height":{"type":"number","format":"double"},"Depth":{"type":"number","format":"double"},"UnitWeight":{"type":"number","format":"double"},"OrderId":{"type":"integer","format":"int32"},"OrderNumber":{"type":"string"}},"xml":{"name":"ItemInTote"},"type":"object"}},"securityDefinitions":{"ms-apikey":{"type":"apiKey","description":"API Key Authentication","name":"ms-apikey","in":"header"}},"tags":[{"name":"Accounting","description":"Actions around Invoicing."},{"name":"ASN","description":"ASN(Advanced Shipping Notice) - For Advising of Deliveries into the Warehouse"},{"name":"Auth","description":"Authorise API"},{"name":"Batch","description":"Actions around Batches."},{"name":"Client","description":"Client API"},{"name":"Courier","description":"Actions around Couriers."},{"name":"Order","description":"Actions around Orders."},{"name":"OrderRules"},{"name":"Product","description":"Products"},{"name":"RefData","description":"Actions around reference data."},{"name":"ReplenPoint"},{"name":"Reports","description":"Actions around Reports."},{"name":"Return","description":"Actions around Returns."},{"name":"Warehouse","description":"Actions around Warehouses."}]}