Blame view
applications/product/servicedef/services_shipment.xml
70.8 KB
c16038356
|
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 |
<?xml version="1.0" encoding="UTF-8"?> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/services.xsd"> <description>Common Application Components Shipment Services</description> <vendor>OFBiz</vendor> <version>1.0</version> <!-- Shipment Services --> <service name="createCarrierShipmentMethod" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createCarrierShipmentMethod" auth="true"> <description>Creates A CarrierShipmentMethod</description> <auto-attributes entity-name="CarrierShipmentMethod" include="pk" mode="IN" optional="false"/> <auto-attributes entity-name="CarrierShipmentMethod" include="nonpk" mode="IN" optional="true"/> </service> <service name="updateCarrierShipmentMethod" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateCarrierShipmentMethod" auth="true"> <description>Updates A CarrierShipmentMethod</description> <auto-attributes entity-name="CarrierShipmentMethod" include="pk" mode="IN" optional="false"/> <auto-attributes entity-name="CarrierShipmentMethod" include="nonpk" mode="IN" optional="true"/> </service> <service name="deleteCarrierShipmentMethod" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteCarrierShipmentMethod" auth="true"> <description>Deletes A CarrierShipmentMethod</description> <auto-attributes entity-name="CarrierShipmentMethod" include="pk" mode="IN" optional="false"/> </service> <service name="createShipmentMethodType" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentMethodType" auth="true"> <description>Creates A ShipmentMethodType</description> <auto-attributes entity-name="ShipmentMethodType" mode="IN" optional="false"/> <override name="sequenceNum" optional="true"/> </service> <service name="updateShipmentMethodType" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateShipmentMethodType" auth="true"> <description>Updates A ShipmentMethodType</description> <auto-attributes entity-name="ShipmentMethodType" mode="IN" optional="false"/> <override name="sequenceNum" optional="true"/> </service> <service name="deleteShipmentMethodType" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteShipmentMethodType" auth="true"> <description>Deletes A ShipmentMethodType</description> <auto-attributes entity-name="ShipmentMethodType" include="pk" mode="IN" optional="false"/> </service> <service name="createOrderShipmentPlan" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createOrderShipmentPlan" auth="true"> <description>Create Shipment, ShipmentItems and OrderShipment</description> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="shipmentId" type="String" mode="OUT" optional="true"/> </service> <service name="quickShipEntireOrder" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="quickShipEntireOrder" auth="true" transaction-timeout="600"> <description>Quick Ships An Entire Order Creating One Shipment Per Facility and Ship Group. All approved order items are automatically issued in full and put into one package. The shipment is created in the INPUT status and then updated to PACKED and SHIPPED. </description> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="originFacilityId" type="String" mode="IN" optional="true"/> <attribute name="setPackedOnly" type="String" mode="IN" optional="true"/> <attribute name="eventDate" type="Timestamp" mode="IN" optional="true"/> <!-- A List of Maps, each with a shipmentId,a facilityId, and a shipGroupSeqId for each shipment created --> <attribute name="shipmentShipGroupFacilityList" type="List" mode="OUT" optional="false"/> </service> <service name="quickShipOrderByItem" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="quickShipOrderByItem" auth="true"> <description>Quick Ships An Order By Item</description> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> <attribute name="itemShipList" type="List" mode="IN" optional="false"/> <attribute name="originFacilityId" type="String" mode="IN" optional="true"/> <attribute name="setPackedOnly" type="String" mode="IN" optional="true"/> <attribute name="shipmentId" type="String" mode="OUT" optional="false"/> </service> <service name="quickShipPurchaseOrder" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="quickShipPurchaseOrder" auth="true"> <description>The mirror of quickShipEntireOrder, this service automatically creates shipments for an entire purchase order. All order items on each ship group is created as a Shipment. All items on a Shipment are automatically issued to a Package. The shipment's status is first set to CREATED and then set as SHIPPED. The facilityId is used to set the destinationFacilityId of the Shipment. </description> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="facilityId" type="String" mode="IN" optional="false"/> </service> <service name="createShipmentForReturn" default-entity-name="ReturnHeader" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentForReturn"> <description>Create a Return Shipment with information from ReturnHeader fields</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <attribute name="shipmentId" type="String" mode="OUT" optional="false"/> </service> <service name="createShipmentAndItemsForReturn" default-entity-name="ReturnHeader" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentAndItemsForReturn"> <description>Create a Return Shipment and ShipmentItems with information from ReturnHeader and ReturnItems</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <attribute name="shipmentId" type="String" mode="OUT" optional="false"/> </service> <service name="createShipmentAndItemsForVendorReturn" default-entity-name="Shipment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentAndItemsForVendorReturn"> <description>Create a Return Shipment and ShipmentItems with primaryReturnId</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> <attribute name="shipmentId" type="String" mode="OUT" optional="false"/> <override name="primaryReturnId" optional="false"/> </service> <service name="createShipment" default-entity-name="Shipment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipment" auth="true"> <description>Create Shipment</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="OUT" optional="false"/> <auto-attributes include="pk" mode="IN" optional="true"/> <auto-attributes include="nonpk" mode="IN" optional="true"> <exclude field-name="createdDate"/> <exclude field-name="createdByUserLogin"/> <exclude field-name="lastModifiedDate"/> <exclude field-name="lastModifiedByUserLogin"/> </auto-attributes> </service> <service name="updateShipment" default-entity-name="Shipment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateShipment" auth="true"> <description>Update Shipment</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <auto-attributes include="pk" mode="INOUT" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"> <exclude field-name="shipmentTypeId"/> <exclude field-name="createdDate"/> <exclude field-name="createdByUserLogin"/> <exclude field-name="lastModifiedDate"/> <exclude field-name="lastModifiedByUserLogin"/> </auto-attributes> <attribute name="shipmentTypeId" type="String" mode="INOUT" optional="true"/> <attribute name="eventDate" type="Timestamp" mode="IN" optional="true"/> <attribute name="oldStatusId" type="String" mode="OUT" optional="true"/> <attribute name="oldPrimaryOrderId" type="String" mode="OUT" optional="true"/> <attribute name="oldOriginFacilityId" type="String" mode="OUT" optional="true"/> <attribute name="oldDestinationFacilityId" type="String" mode="OUT" optional="true"/> </service> <service name="deleteShipment" default-entity-name="Shipment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteShipment" auth="true"> <description>Delete Shipment</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes include="pk" mode="IN" optional="false"/> </service> <service name="setShipmentSettingsFromPrimaryOrder" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="setShipmentSettingsFromPrimaryOrder" auth="true"> <description>Set Shipment Settings From Primary Order</description> <required-permissions join-type="AND"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> </required-permissions> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> </service> <service name="setShipmentSettingsFromFacilities" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="setShipmentSettingsFromFacilities" auth="true"> <description>Set Shipment Settings From Facilities</description> <required-permissions join-type="AND"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> </required-permissions> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> </service> <service name="sendShipmentScheduledNotification" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="sendShipmentScheduledNotification" auth="true"> <description>Send Shipment Scheduled Notification</description> <required-permissions join-type="OR"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> </required-permissions> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> </service> <service name="balanceItemIssuancesForShipment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="balanceItemIssuancesForShipment" auth="true"> <description> Release the purchase order's items assigned to the shipment but not actually received; it is invoked as a seca when the purchase shipment is marked as 'received' </description> <required-permissions join-type="OR"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> </required-permissions> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> </service> <service name="checkCancelItemIssuanceAndOrderShipmentFromShipment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="checkCancelItemIssuanceAndOrderShipmentFromShipment" auth="true"> <description>Check Shipment Items and cancel Item Issuance and Order Shipment</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> </service> <service name="quickDropShipOrder" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="quickDropShipOrder" auth="true"> <description>Creates a drop shipment for a ship group and calls updateShipment twice in succession to set shipment status to PURCH_SHIP_SHIPPED and then to PURCH_SHIP_RECEIVED</description> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> <attribute name="shipmentId" type="String" mode="OUT" optional="false"/> </service> <!-- ShipmentItem Services --> <service name="createShipmentItem" default-entity-name="ShipmentItem" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentItem" auth="true"> <description>Create ShipmentItem</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> <override name="shipmentItemSeqId" mode="INOUT" optional="true"/> </service> <service name="updateShipmentItem" default-entity-name="ShipmentItem" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateShipmentItem" auth="true"> <description>Update ShipmentItem</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> </service> <service name="deleteShipmentItem" default-entity-name="ShipmentItem" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteShipmentItem" auth="true"> <description>Delete ShipmentItem</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes include="pk" mode="IN" optional="false"/> </service> <service name="splitShipmentItemByQuantity" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="splitShipmentItemByQuantity"> <description>Splits the specified ShipmentItem creating a new ShipmentItem with the given newItemQuantity. NOTE that this does manage OrderShipment records, but NOTHING else, so it is only to be used for Shipment Plan stuff BEFORE the items are issued, shipment packed, etc.</description> <auto-attributes entity-name="ShipmentItem" include="pk" mode="IN" optional="false"/> <attribute name="newItemQuantity" type="BigDecimal" mode="IN" optional="false"/> <attribute name="newShipmentItemSeqId" type="String" mode="OUT" optional="true"/> </service> <!-- ShipmentPackage Services --> <service name="createShipmentPackage" default-entity-name="ShipmentPackage" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentPackage" auth="true"> <description>Create ShipmentPackage</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"> <exclude field-name="dateCreated"/> </auto-attributes> <override name="shipmentPackageSeqId" mode="INOUT" optional="true"/> </service> <service name="updateShipmentPackage" default-entity-name="ShipmentPackage" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateShipmentPackage" auth="true"> <description>Update ShipmentPackage</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> </service> <service name="deleteShipmentPackage" default-entity-name="ShipmentPackage" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteShipmentPackage" auth="true"> <description>Delete ShipmentPackage</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes include="pk" mode="IN" optional="false"/> </service> <!-- ShipmentPackageContent Services --> <service name="createShipmentPackageContent" default-entity-name="ShipmentPackageContent" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentPackageContent" auth="true"> <description>Create ShipmentPackageContent</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> <override name="shipmentPackageSeqId" mode="INOUT" optional="false"/> </service> <service name="updateShipmentPackageContent" default-entity-name="ShipmentPackageContent" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateShipmentPackageContent" auth="true"> <description>Update ShipmentPackageContent</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> </service> <service name="deleteShipmentPackageContent" default-entity-name="ShipmentPackageContent" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteShipmentPackageContent" auth="true"> <description>Delete ShipmentPackageContent</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes include="pk" mode="IN" optional="false"/> </service> <service name="addShipmentContentToPackage" default-entity-name="ShipmentPackageContent" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="addShipmentContentToPackage" auth="true"> <description>Add Shipment Content To Package</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> <override name="quantity" mode="IN" optional="false"/> <override name="shipmentPackageSeqId" mode="INOUT" optional="false"/> </service> <!-- ShipmentPackageRouteSeg Services --> <service name="createShipmentPackageRouteSeg" default-entity-name="ShipmentPackageRouteSeg" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentPackageRouteSeg" auth="true"> <description>Create ShipmentPackageRouteSeg</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> </service> <service name="updateShipmentPackageRouteSeg" default-entity-name="ShipmentPackageRouteSeg" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateShipmentPackageRouteSeg" auth="true"> <description>Update ShipmentPackageRouteSeg</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> </service> <service name="deleteShipmentPackageRouteSeg" default-entity-name="ShipmentPackageRouteSeg" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteShipmentPackageRouteSeg" auth="true"> <description>Delete ShipmentPackageRouteSeg</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes include="pk" mode="IN" optional="false"/> </service> <!-- ShipmentContactMech Services --> <service name="createShipmentContactMech" default-entity-name="ShipmentContactMech" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentContactMech" auth="true"> <description>Create ShipmentContactMech</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> </service> <service name="updateShipmentContactMech" default-entity-name="ShipmentContactMech" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateShipmentContactMech" auth="true"> <description>Update ShipmentContactMech</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> </service> <service name="deleteShipmentContactMech" default-entity-name="ShipmentContactMech" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteShipmentContactMech" auth="true"> <description>Delete ShipmentContactMech</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes include="pk" mode="IN" optional="false"/> </service> <!-- ShipmentRouteSegment Services --> <service name="createShipmentRouteSegment" default-entity-name="ShipmentRouteSegment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createShipmentRouteSegment" auth="true"> <description>Create ShipmentRouteSegment</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> <override name="shipmentRouteSegmentId" mode="INOUT" optional="true"/> </service> <service name="updateShipmentRouteSegment" default-entity-name="ShipmentRouteSegment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateShipmentRouteSegment" auth="true"> <description>Update ShipmentRouteSegment</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> </service> <service name="deleteShipmentRouteSegment" default-entity-name="ShipmentRouteSegment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteShipmentRouteSegment" auth="true"> <description>Delete ShipmentRouteSegment</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes include="pk" mode="IN" optional="false"/> </service> <service name="duplicateShipmentRouteSegment" default-entity-name="ShipmentRouteSegment" engine="java" location="org.ofbiz.shipment.shipment.ShipmentServices" invoke="duplicateShipmentRouteSegment" auth="true"> <description>Duplicates a shipment route segment and creates the new route segment in the NOT_STARTED status</description> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> <attribute name="newShipmentRouteSegmentId" type="String" mode="OUT" optional="false"/> </service> <service name="quickScheduleShipmentRouteSegment" default-entity-name="ShipmentRouteSegment" engine="java" location="org.ofbiz.shipment.shipment.ShipmentServices" invoke="quickScheduleShipmentRouteSegment" auth="true"> <description>Schedules a shipment route segment with the carrier and service level in the ShipmentRouteSegment entity. Actual scheduling is done by an async service, and this does not return an error, so it can be called in a multi-form, and one failed shipment scheduling does not cause other shipments to be rolled back. </description> <auto-attributes include="pk" mode="IN" optional="false"/> </service> <!-- ============================================================== --> <!-- ItemIssuance Services --> <service name="createItemIssuance" default-entity-name="ItemIssuance" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="createItemIssuance" auth="true"> <description>Create ItemIssuance</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="OUT" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> <attribute name="affectAccounting" type="Boolean" mode="OUT" optional="true"/> </service> <service name="updateItemIssuance" default-entity-name="ItemIssuance" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="updateItemIssuance" auth="true"> <description>Update ItemIssuance</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="true"/> </service> <service name="deleteItemIssuance" default-entity-name="ItemIssuance" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="deleteItemIssuance" auth="true"> <description>Delete ItemIssuance</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes include="pk" mode="IN" optional="false"/> </service> <!-- ItemIssuanceRole Services --> <service name="createItemIssuanceRole" default-entity-name="ItemIssuanceRole" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="createItemIssuanceRole" auth="true"> <description>Create ItemIssuanceRole</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <!-- Will check if OK to change status of shipment, so Shipment PK is needed --> <auto-attributes entity-name="Shipment" include="pk" mode="IN" optional="false"/> </service> <service name="deleteItemIssuanceRole" default-entity-name="ItemIssuanceRole" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="deleteItemIssuanceRole" auth="true"> <description>Delete ItemIssuanceRole</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes include="pk" mode="IN" optional="false"/> <!-- Will check if OK to change status of shipment, so Shipment PK is needed --> <auto-attributes entity-name="Shipment" include="pk" mode="IN" optional="false"/> </service> <service name="issueOrderItemToShipment" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="issueOrderItemToShipment" auth="true"> <description>Issue an OrderItem to a Shipment - only for non-sales orders</description> <required-permissions join-type="AND"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> </required-permissions> <auto-attributes entity-name="Shipment" include="pk" mode="IN" optional="false"/> <auto-attributes entity-name="OrderItemShipGroupAssoc" include="pk" mode="IN" optional="false"/> <attribute name="quantity" type="BigDecimal" mode="IN" optional="false"/> <attribute name="shipmentItemSeqId" type="String" mode="OUT" optional="false"/> </service> <service name="issueOrderItemShipGrpInvResToShipment" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="issueOrderItemShipGrpInvResToShipment" auth="true"> <description>Add an OrderItemShipGrpInvRes to a Shipment - only for sales orders</description> <required-permissions join-type="AND"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> </required-permissions> <auto-attributes entity-name="Shipment" include="pk" mode="IN" optional="false"/> <auto-attributes entity-name="OrderItemShipGrpInvRes" include="pk" mode="IN" optional="false"/> <attribute name="quantity" type="BigDecimal" mode="IN" optional="false"/> <attribute name="eventDate" type="Timestamp" mode="IN" optional="true"/> <attribute name="shipmentItemSeqId" type="String" mode="OUT" optional="false"/> <attribute name="itemIssuanceId" type="String" mode="OUT" optional="false"/> </service> <service name="issueInventoryItemToFixedAssetMaint" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="issueInventoryItemToFixedAssetMaint" auth="true"> <description>Issue an InventoryItem to a FixedAssetMaint - for conversion to use as supples/parts</description> <auto-attributes entity-name="InventoryItem" include="pk" mode="IN" optional="false"/> <auto-attributes entity-name="FixedAssetMaint" include="pk" mode="IN" optional="false"/> <attribute name="quantity" type="BigDecimal" mode="IN" optional="false"/> <attribute name="itemIssuanceId" type="String" mode="OUT" optional="false"/> </service> <service name="returnInventoryItemIssuedToFixedAssetMaint" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="returnInventoryItemIssuedToFixedAssetMaint" auth="true"> <description>Return InventoryItem Issued to a FixedAssetMaint - for conversion to use as supples/parts</description> <attribute name="itemIssuanceId" type="String" mode="IN" optional="false"/> </service> <service name="cancelOrderItemIssuanceFromSalesShipment" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="cancelOrderItemIssuanceFromSalesShipment" auth="true"> <description>Cancel an ItemIssuance from Sales Shipment</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <attribute name="itemIssuanceId" type="String" mode="IN" optional="false"/> <attribute name="cancelQuantity" type="BigDecimal" mode="IN" optional="true"/> <attribute name="canceledQuantity" type="BigDecimal" mode="OUT" optional="false"/> </service> <service name="issueInventoryItemToShipment" engine="simple" location="component://product/script/org/ofbiz/shipment/issuance/IssuanceServices.xml" invoke="issueInventoryItemToShipment" auth="true"> <description>Issue an InventoryItem to a Shipment</description> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> <attribute name="shipmentItemSeqId" type="String" mode="IN" optional="false"/> <attribute name="inventoryItemId" type="String" mode="IN" optional="false"/> <attribute name="quantity" type="BigDecimal" mode="IN" optional="false"/> <attribute name="totalIssuedQty" type="BigDecimal" mode="IN" optional="false"/> <attribute name="itemIssuanceId" type="String" mode="OUT" optional="false"/> </service> <!-- Pick Verify Services --> <service name="verifySingleItem" engine="java" location="org.ofbiz.shipment.verify.VerifyPickServices" invoke="verifySingleItem" auth="true"> <description>Verify Single Item</description> <attribute name="verifyPickSession" type="org.ofbiz.shipment.verify.VerifyPickSession" mode="IN" optional="false"/> <attribute name="productId" type="String" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="true"/> <attribute name="shipGroupSeqId" type="String" mode="IN" optional="true"/> <attribute name="quantity" type="BigDecimal" mode="IN" optional="true"/> </service> <service name="verifyBulkItem" engine="java" location="org.ofbiz.shipment.verify.VerifyPickServices" invoke="verifyBulkItem" auth="true"> <description>Verify Multiple Items</description> <attribute name="verifyPickSession" type="org.ofbiz.shipment.verify.VerifyPickSession" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> <attribute name="facilityId" type="String" mode="IN" optional="true"/> <attribute name="pickerPartyId" type="String" mode="IN" optional="true"/> <attribute name="productMap" type="Map" string-map-prefix="prd_" mode="IN" optional="true"/> <attribute name="originGeoIdMap" type="Map" string-map-prefix="geo_" mode="IN" optional="true"/> <attribute name="quantityMap" type="Map" string-map-prefix="qty_" mode="IN" optional="true"/> <attribute name="selectedMap" type="Map" string-map-prefix="sel_" mode="IN" optional="true"/> <attribute name="itemMap" type="Map" string-map-prefix="ite_" mode="IN" optional="true"/> </service> <service name="cancelAllRows" engine="java" location="org.ofbiz.shipment.verify.VerifyPickServices" invoke="cancelAllRows" auth="true"> <description>Clear the current picking session</description> <attribute name="verifyPickSession" type="org.ofbiz.shipment.verify.VerifyPickSession" mode="IN" optional="false"/> </service> <service name="completeVerifiedPick" engine="java" location="org.ofbiz.shipment.verify.VerifyPickServices" invoke="completeVerifiedPick" auth="true"> <description>Complete the picking and set the shipment to PICKED</description> <attribute name="verifyPickSession" type="org.ofbiz.shipment.verify.VerifyPickSession" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> <attribute name="facilityId" type="String" mode="IN" optional="true"/> <attribute name="pickerPartyId" type="String" mode="IN" optional="true"/> <attribute name="shipmentId" type="String" mode="INOUT" optional="true"/> </service> <!-- Weight Package Only Services --> <service name="setPackageInfo" engine="java" location="org.ofbiz.shipment.weightPackage.WeightPackageServices" invoke="setPackageInfo" auth="true"> <description>Set the weight, dimensions/shipmentBoxType of package in SESSION</description> <attribute name="weightPackageSession" type="org.ofbiz.shipment.weightPackage.WeightPackageSession" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="packageWeight" type="BigDecimal" mode="IN" optional="true"/> <attribute name="packageLength" type="BigDecimal" mode="IN" optional="true"/> <attribute name="packageWidth" type="BigDecimal" mode="IN" optional="true"/> <attribute name="packageHeight" type="BigDecimal" mode="IN" optional="true"/> <attribute name="shipmentBoxTypeId" type="String" mode="IN" optional="true"/> </service> <service name="updatePackedLine" engine="java" location="org.ofbiz.shipment.weightPackage.WeightPackageServices" invoke="updatePackedLine" auth="true"> <description>Update the weight, dimensions/shipmentBoxType of package</description> <attribute name="weightPackageSession" type="org.ofbiz.shipment.weightPackage.WeightPackageSession" mode="IN" optional="false"/> <attribute name="packageWeight" type="BigDecimal" mode="IN" optional="true"/> <attribute name="packageLength" type="BigDecimal" mode="IN" optional="true"/> <attribute name="packageWidth" type="BigDecimal" mode="IN" optional="true"/> <attribute name="packageHeight" type="BigDecimal" mode="IN" optional="true"/> <attribute name="shipmentBoxTypeId" type="String" mode="IN" optional="true"/> <attribute name="weightPackageSeqId" type="Integer" mode="IN" optional="false"/> </service> <service name="deletePackedLine" engine="java" location="org.ofbiz.shipment.weightPackage.WeightPackageServices" invoke="deletePackedLine" auth="true"> <description>Delete the weight, dimensions/shipmentBoxType of package</description> <attribute name="weightPackageSession" type="org.ofbiz.shipment.weightPackage.WeightPackageSession" mode="IN" optional="false"/> <attribute name="weightPackageSeqId" type="Integer" mode="IN" optional="false"/> </service> <service name="completePackage" engine="java" location="org.ofbiz.shipment.weightPackage.WeightPackageServices" invoke="completePackage" auth="true"> <description>Complete the packging and set the shipment to packed</description> <attribute name="weightPackageSession" type="org.ofbiz.shipment.weightPackage.WeightPackageSession" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="invoiceId" type="String" mode="IN" optional="false"/> <attribute name="facilityId" type="String" mode="IN" optional="true"/> <attribute name="dimensionUomId" type="String" mode="IN" optional="true"/> <attribute name="weightUomId" type="String" mode="IN" optional="true"/> <attribute name="estimatedShippingCost" type="BigDecimal" mode="IN" optional="true"/> <attribute name="newEstimatedShippingCost" type="BigDecimal" mode="IN" optional="true"/> <attribute name="shipmentId" type="String" mode="INOUT" optional="true"/> <attribute name="showWarningForm" type="Boolean" mode="OUT" optional="true"/> </service> <service name="completeShipment" engine="java" location="org.ofbiz.shipment.weightPackage.WeightPackageServices" invoke="completeShipment" auth="true"> <description>Complete the packaging set the shipment to packed</description> <attribute name="weightPackageSession" type="org.ofbiz.shipment.weightPackage.WeightPackageSession" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="facilityId" type="String" mode="IN" optional="true"/> <attribute name="shipmentId" type="String" mode="INOUT" optional="true"/> </service> <service name="savePackagesInfo" engine="java" location="org.ofbiz.shipment.weightPackage.WeightPackageServices" invoke="savePackagesInfo" auth="true"> <description>Save the package(s) information in ShipmentPackage entity from session</description> <attribute name="weightPackageSession" type="org.ofbiz.shipment.weightPackage.WeightPackageSession" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> <attribute name="facilityId" type="String" mode="IN" optional="true"/> </service> <!-- Pack Order Services --> <service name="packSingleItem" engine="java" location="org.ofbiz.shipment.packing.PackingServices" invoke="addPackLine" auth="true"> <description>Pack Single Item</description> <attribute name="packingSession" type="org.ofbiz.shipment.packing.PackingSession" mode="IN" optional="false"/> <attribute name="productId" type="String" mode="IN" optional="true"/> <attribute name="orderId" type="String" mode="IN" optional="true"/> <attribute name="shipGroupSeqId" type="String" mode="IN" optional="true"/> <attribute name="quantity" type="BigDecimal" mode="IN" optional="true"/> <attribute name="packageSeq" type="Integer" mode="IN" optional="false"/> <attribute name="pickerPartyId" type="String" mode="IN" optional="true"/> <attribute name="handlingInstructions" type="String" mode="IN" optional="true"/> </service> <service name="packBulkItems" engine="java" location="org.ofbiz.shipment.packing.PackingServices" invoke="packBulk" auth="true"> <description>Pack Multiple Items</description> <attribute name="packingSession" type="org.ofbiz.shipment.packing.PackingSession" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> <attribute name="updateQuantity" type="Boolean" mode="IN" optional="true"/> <attribute name="pickerPartyId" type="String" mode="IN" optional="true"/> <attribute name="handlingInstructions" type="String" mode="IN" optional="true"/> <attribute name="nextPackageSeq" type="Integer" mode="INOUT" optional="true"/> <attribute name="prdInfo" type="Map" string-map-prefix="prd_" mode="IN" optional="true"/> <attribute name="qtyInfo" type="Map" string-map-prefix="qty_" mode="IN" optional="true"/> <attribute name="pkgInfo" type="Map" string-map-prefix="pkg_" mode="IN" optional="true"/> <attribute name="selInfo" type="Map" string-map-prefix="sel_" mode="IN" optional="true"/> <attribute name="iteInfo" type="Map" string-map-prefix="ite_" mode="IN" optional="true"/> <attribute name="wgtInfo" type="Map" string-map-prefix="wgt_" mode="IN" optional="true"/> <attribute name="numPackagesInfo" type="Map" string-map-prefix="numPackages_" mode="IN" optional="true"/> </service> <service name="setNextPackageSeq" engine="java" location="org.ofbiz.shipment.packing.PackingServices" invoke="incrementPackageSeq" auth="true"> <description>Increments the next package sequence</description> <attribute name="packingSession" type="org.ofbiz.shipment.packing.PackingSession" mode="IN" optional="false"/> <attribute name="nextPackageSeq" type="Integer" mode="OUT" optional="false"/> </service> <service name="calcPackSessionAdditionalShippingCharge" engine="java" location="org.ofbiz.shipment.packing.PackingServices" invoke="calcPackSessionAdditionalShippingCharge" auth="true"> <description>Totals package weights and calls the calcShipmentCostEstimate via the PackingSession</description> <attribute name="packingSession" type="org.ofbiz.shipment.packing.PackingSession" mode="IN" optional="false"/> <attribute name="packageWeights" type="Map" string-map-prefix="packageWeight_" mode="IN" optional="true"/> <attribute name="weightUomId" type="String" mode="IN" optional="true"/> <attribute name="shippingContactMechId" type="String" mode="IN" optional="false"/> <attribute name="shipmentMethodTypeId" type="String" mode="IN" optional="false"/> <attribute name="carrierPartyId" type="String" mode="IN" optional="false"/> <attribute name="carrierRoleTypeId" type="String" mode="IN" optional="false"/> <attribute name="productStoreId" type="String" mode="IN" optional="false"/> <attribute name="additionalShippingCharge" type="BigDecimal" mode="OUT" optional="true"/> </service> <service name="clearPackAll" engine="java" location="org.ofbiz.shipment.packing.PackingServices" invoke="clearPackAll" auth="true"> <description>Clear the current packing session</description> <attribute name="packingSession" type="org.ofbiz.shipment.packing.PackingSession" mode="IN" optional="false"/> </service> <service name="clearLastPackage" engine="java" location="org.ofbiz.shipment.packing.PackingServices" invoke="clearLastPackage" auth="true"> <description>Clears the last package in the packing session</description> <attribute name="packingSession" type="org.ofbiz.shipment.packing.PackingSession" mode="IN" optional="false"/> <attribute name="nextPackageSeq" type="Integer" mode="OUT" optional="false"/> </service> <service name="clearPackLine" engine="java" location="org.ofbiz.shipment.packing.PackingServices" invoke="clearPackLine" auth="true"> <description>Clear a single line from the current packing session</description> <attribute name="packingSession" type="org.ofbiz.shipment.packing.PackingSession" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="orderItemSeqId" type="String" mode="IN" optional="false"/> <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> <attribute name="productId" type="String" mode="IN" optional="false"/> <attribute name="inventoryItemId" type="String" mode="IN" optional="false"/> <attribute name="packageSeqId" type="Integer" mode="IN" optional="false"/> </service> <service name="completePack" engine="java" location="org.ofbiz.shipment.packing.PackingServices" invoke="completePack" auth="true" transaction-timeout="7200"> <description>Complete the packaging set the shipment to PACKED</description> <attribute name="packingSession" type="org.ofbiz.shipment.packing.PackingSession" mode="IN" optional="false"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="invoiceId" type="String" mode="IN" optional="true"/> <attribute name="shipmentId" type="String" mode="IN" optional="true"/> <attribute name="handlingInstructions" type="String" mode="IN" optional="true"/> <attribute name="pickerPartyId" type="String" mode="IN" optional="true"/> <attribute name="additionalShippingCharge" type="BigDecimal" mode="IN" optional="true"/> <attribute name="forceComplete" type="Boolean" mode="IN" optional="true"/> <attribute name="packageWeights" type="Map" string-map-prefix="packageWeight_" mode="IN" optional="true"/> <attribute name="dimensionUomId" type="String" mode="IN" optional="true"/> <attribute name="weightUomId" type="String" mode="IN" optional="true"/> <attribute name="shipmentId" type="String" mode="OUT" optional="false"/> <attribute name="boxTypes" type="Map" string-map-prefix="boxType_" mode="IN" optional="true"/> </service> <!-- Shipment Plan Services --> <service name="addOrderShipmentToShipment" engine="simple" default-entity-name="OrderShipment" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="addOrderShipmentToShipment" auth="true"> <description>Add an OrderShipment and a ShipmentItem - only for sales orders</description> <required-permissions join-type="AND"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> </required-permissions> <auto-attributes include="pk" mode="IN" optional="false"/> <auto-attributes include="nonpk" mode="IN" optional="false"/> <override name="shipmentItemSeqId" mode="IN" optional="true"/> </service> <service name="removeOrderShipmentFromShipment" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="removeOrderShipmentFromShipment" auth="true"> <description>Delete an OrderShipment and updates the ShipmentItem</description> <required-permissions join-type="AND"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> </required-permissions> <auto-attributes entity-name="OrderShipment" include="pk" mode="IN" optional="false"/> </service> <service name="getQuantityForShipment" engine="simple" default-entity-name="OrderItem" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="getQuantityForShipment" auth="true"> <description>get the order item quantity still not put in shipments</description> <auto-attributes include="pk" mode="IN" optional="false"/> <attribute name="remainingQuantity" type="BigDecimal" mode="OUT" optional="false"/> </service> <!-- ============================================================== --> <!-- Receipt Services --> <service name="interfaceShipmentReceipt" engine="interface" location="" invoke=""> <description>ShipmentReceipt Interface</description> <auto-attributes entity-name="ShipmentReceipt" include="nonpk" mode="IN" optional="true"/> <attribute name="inventoryItemDetailSeqId" type="String" mode="IN" optional="true"/> <override name="inventoryItemId" optional="false"/> <override name="productId" optional="false"/> <override name="quantityAccepted" optional="false"/> <override name="quantityRejected" optional="false"/> </service> <service name="createShipmentReceipt" engine="simple" location="component://product/script/org/ofbiz/shipment/receipt/ShipmentReceiptServices.xml" invoke="createShipmentReceipt" auth="true"> <description>Creates a ShipmentReceipt Record</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <implements service="interfaceShipmentReceipt"/> <attribute name="receiptId" type="String" mode="OUT" optional="false"/> <attribute name="affectAccounting" type="Boolean" mode="OUT" optional="true"/> </service> <service name="updatePurchaseShipmentFromReceipt" engine="java" location="org.ofbiz.shipment.shipment.ShipmentServices" invoke="updatePurchaseShipmentFromReceipt" auth="true"> <description> Whenever a ShipmentReceipt is generated, check the Shipment associated with it to see if all items were received. If so, change its status to PURCH_SHIP_RECEIVED. The check is accomplished by counting the products shipped (from ShipmentAndItem) and matching them with the products received (from ShipmentReceipt). </description> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> </service> <service name="receiveInventoryProduct" engine="simple" transaction-timeout="600" location="component://product/script/org/ofbiz/shipment/receipt/ShipmentReceiptServices.xml" invoke="receiveInventoryProduct" auth="true"> <description>Receive Inventory In Warehouse</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes entity-name="InventoryItem" include="nonpk" mode="IN" optional="true"> <exclude field-name="availableToPromiseTotal"/> <exclude field-name="quantityOnHandTotal"/> </auto-attributes> <auto-attributes entity-name="InventoryItemDetail" include="nonpk" mode="IN" optional="true"/> <auto-attributes entity-name="ShipmentReceipt" include="nonpk" mode="IN" optional="true"/> <attribute name="inventoryItemDetailSeqId" type="String" mode="IN" optional="true"/> <attribute name="priorityOrderId" type="String" mode="IN" optional="true"/> <attribute name="priorityOrderItemSeqId" type="String" mode="IN" optional="true"/> <attribute name="currentInventoryItemId" type="String" mode="IN" optional="true"><!-- allow this to be passed in to update an existing InventoryItem, and all else is the same; if not passed in a new one will be created --></attribute> <attribute name="inventoryItemId" type="String" mode="OUT" optional="true"></attribute> <attribute name="orderCurrencyUnitPrice" type="String" mode="IN" optional="true"/> <override name="quantityAccepted" optional="false"/> <override name="quantityRejected" optional="false"/> <override name="inventoryItemTypeId" optional="false"/> <override name="productId" optional="false"/> <override name="facilityId" optional="false"/> </service> <service name="issueOrderItemToShipmentAndReceiveAgainstPO" engine="simple" transaction-timeout="600" location="component://product/script/org/ofbiz/shipment/receipt/ShipmentReceiptServices.xml" invoke="issueOrderItemToShipmentAndReceiveAgainstPO" auth="true"> <description>Issues order item quantity specified to the shipment, then receives inventory for that item and quantity</description> <required-permissions join-type="AND"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> </required-permissions> <implements service="issueOrderItemToShipment"/> <implements service="receiveInventoryProduct"/> </service> <service name="quickReceiveReturn" engine="simple" location="component://product/script/org/ofbiz/shipment/receipt/ShipmentReceiptServices.xml" invoke="quickReceiveReturn" auth="true"> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <attribute name="returnId" type="String" mode="IN" optional="false"/> <attribute name="inventoryItemTypeId" type="String" mode="IN" optional="true"/> <attribute name="statusId" type="String" mode="IN" optional="true"/> </service> <service name="interfaceShipmentReceiptRole" engine="interface" location="" invoke=""> <description>Interface for ShipmentReceiptRole</description> <attribute name="receiptId" type="String" mode="IN" optional="false"/> <attribute name="partyId" type="String" mode="IN" optional="false"/> <attribute name="roleTypeId" type="String" mode="IN" optional="false"/> </service> <service name="createShipmentReceiptRole" engine="simple" location="component://product/script/org/ofbiz/shipment/receipt/ShipmentReceiptServices.xml" invoke="createShipmentReceiptRole" auth="true"> <description>Create a ShipmentReceipt Role entry</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <implements service="interfaceShipmentReceiptRole"/> </service> <service name="removeShipmentReceiptRole" engine="simple" location="component://product/script/org/ofbiz/shipment/receipt/ShipmentReceiptServices.xml" invoke="removeShipmentReceiptRole" auth="true"> <description>Remove a ShipmentReceipt Role entry</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <implements service="interfaceShipmentReceiptRole"/> </service> <!-- Shipment Estimate (Rate) Services --> <service name="createShipmentEstimate" engine="java" location="org.ofbiz.shipment.shipment.ShipmentServices" invoke="createShipmentEstimate" auth="true"> <description>Create Shipment Estimate</description> <attribute name="productStoreShipMethId" type="String" mode="IN" optional="false"/> <attribute name="toGeo" type="String" mode="IN" optional="true"/> <attribute name="fromGeo" type="String" mode="IN" optional="true"/> <attribute name="partyId" type="String" mode="IN" optional="true"/> <attribute name="roleTypeId" type="String" mode="IN" optional="true"/> <attribute name="flatPercent" type="BigDecimal" mode="IN" optional="false"/> <attribute name="flatPrice" type="BigDecimal" mode="IN" optional="true"/> <attribute name="flatItemPrice" type="BigDecimal" mode="IN" optional="true"/> <attribute name="shippingPricePercent" type="BigDecimal" mode="IN" optional="true"/> <attribute name="productFeatureGroupId" type="String" mode="IN" optional="true"/> <attribute name="featurePercent" type="BigDecimal" mode="IN" optional="true"/> <attribute name="featurePrice" type="BigDecimal" mode="IN" optional="true"/> <attribute name="oversizeUnit" type="BigDecimal" mode="IN" optional="true"/> <attribute name="oversizePrice" type="BigDecimal" mode="IN" optional="true"/> <attribute name="weightBreakId" type="String" mode="IN" optional="true"/> <attribute name="wmin" type="BigDecimal" mode="IN" optional="true"/> <attribute name="wmax" type="BigDecimal" mode="IN" optional="true"/> <attribute name="wprice" type="BigDecimal" mode="IN" optional="true"/> <attribute name="wuom" type="String" mode="IN" optional="true"/> <attribute name="quantityBreakId" type="String" mode="IN" optional="true"/> <attribute name="qmin" type="BigDecimal" mode="IN" optional="true"/> <attribute name="qmax" type="BigDecimal" mode="IN" optional="true"/> <attribute name="qprice" type="BigDecimal" mode="IN" optional="true"/> <attribute name="quom" type="String" mode="IN" optional="true"/> <attribute name="priceBreakId" type="String" mode="IN" optional="true"/> <attribute name="pmin" type="BigDecimal" mode="IN" optional="true"/> <attribute name="pmax" type="BigDecimal" mode="IN" optional="true"/> <attribute name="pprice" type="BigDecimal" mode="IN" optional="true"/> <attribute name="puom" type="String" mode="IN" optional="true"/> <attribute name="shipmentCostEstimateId" type="String" mode="OUT"/> </service> <service name="removeShipmentEstimate" engine="java" location="org.ofbiz.shipment.shipment.ShipmentServices" invoke="removeShipmentEstimate" auth="true"> <description>Remove Shipment Estimate</description> <attribute name="shipmentCostEstimateId" type="String" mode="IN" optional="false"/> </service> <service name="calcShipmentEstimateInterface" engine="interface" location="" invoke=""> <description>Interface for shipment estimate calc service</description> <attribute name="serviceConfigProps" type="String" mode="IN" optional="true"/> <attribute name="initialEstimateAmt" type="BigDecimal" mode="IN" optional="true"/> <attribute name="shippingContactMechId" type="String" mode="IN" optional="true"/> <attribute name="shippingOriginContactMechId" type="String" mode="IN" optional="true"/> <attribute name="shippingPostalCode" type="String" mode="IN" optional="true"/> <attribute name="shippingCountryCode" type="String" mode="IN" optional="true"/> <attribute name="shipmentMethodTypeId" type="String" mode="IN" optional="false"/> <attribute name="carrierPartyId" type="String" mode="IN" optional="false"/> <attribute name="carrierRoleTypeId" type="String" mode="IN" optional="false"/> <attribute name="productStoreShipMethId" type="String" mode="IN" optional="true"/> <attribute name="productStoreId" type="String" mode="IN" optional="false"/> <attribute name="shippableItemInfo" type="List" mode="IN" optional="false"/> <attribute name="shippableWeight" type="BigDecimal" mode="IN" optional="false"/> <attribute name="shippableQuantity" type="BigDecimal" mode="IN" optional="false"/> <attribute name="shippableTotal" type="BigDecimal" mode="IN" optional="false"/> <attribute name="partyId" type="String" mode="IN" optional="true"/> <attribute name="shipmentCustomMethodId" type="String" mode="IN" optional="true"/> <attribute name="shipmentGatewayConfigId" type="String" mode="IN" optional="true"/> <attribute name="shippingEstimateAmount" type="BigDecimal" mode="OUT" optional="false"/> </service> <service name="calcShipmentCostEstimate" engine="java" location="org.ofbiz.shipment.shipment.ShipmentServices" invoke="calcShipmentCostEstimate" auth="false" use-transaction="false"> <description>Generic Shipment Cost Estimate Calc Service - Use ShipmentCostEstimate Entities</description> <implements service="calcShipmentEstimateInterface"/> </service> <service name="cancelReceivedItems" engine="simple" location="component://product/script/org/ofbiz/shipment/receipt/ShipmentReceiptServices.xml" invoke="cancelReceivedItems" auth="true"> <description>Cancel Received Items against a purchase order if received something incorrectly</description> <attribute name="receiptId" type="String" mode="IN" optional="false"/> <attribute name="facilityId" type="String" mode="IN" optional="true"/> </service> <!-- QuantityBreak services --> <service name="createQuantityBreak" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="createQuantityBreak" auth="true"> <description>Create a QuantityBreak</description> <permission-service service-name="facilityGenericPermission" main-action="CREATE"/> <auto-attributes entity-name="QuantityBreak" include="nonpk" mode="IN" optional="true"/> </service> <service name="updateQuantityBreak" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="updateQuantityBreak" auth="true"> <description>Update a QuantityBreak</description> <permission-service service-name="facilityGenericPermission" main-action="UPDATE"/> <auto-attributes entity-name="QuantityBreak" include="pk" mode="IN" optional="false"/> <auto-attributes entity-name="QuantityBreak" include="nonpk" mode="IN" optional="true"/> </service> <service name="deleteQuantityBreak" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="deleteQuantityBreak" auth="true"> <description>Delete a QuantityBreak</description> <permission-service service-name="facilityGenericPermission" main-action="DELETE"/> <auto-attributes entity-name="QuantityBreak" include="pk" mode="IN" optional="false"/> </service> <service name="getShipmentPackageValueFromOrders" engine="java" location="org.ofbiz.shipment.shipment.ShipmentServices" invoke="getShipmentPackageValueFromOrders" auth="true" use-transaction="false"> <description>Calculates the total value of a shipment package by totalling the results of the getOrderItemInvoicedAmountAndQuantity service for the orderItem related to each ShipmentPackageContent, prorated by the quantity of the orderItem issued to the ShipmentPackageContent. Value is converted according to the incoming currencyUomId.</description> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> <attribute name="shipmentPackageSeqId" type="String" mode="IN" optional="false"/> <attribute name="currencyUomId" type="String" mode="IN" optional="false"/> <attribute name="packageValue" type="BigDecimal" mode="OUT" optional="true"/> </service> <service name="issueSerializedInvToShipmentPackageAndSetTracking" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="issueSerializedInvToShipmentPackageAndSetTracking" auth="true"> <description></description> <attribute name="inventoryItemId" type="String" mode="IN" optional="false"/> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> <attribute name="productId" type="String" mode="IN" optional="true"/> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="orderItemSeqId" type="String" mode="IN" optional="false"/> <attribute name="shipGroupSeqId" type="String" mode="IN" optional="false"/> <attribute name="quantity" type="BigDecimal" mode="IN" optional="true"/> <attribute name="reservedDatetime" type="Timestamp" mode="IN" optional="true"/> <attribute name="requireInventory" type="String" mode="IN" optional="true"/> <attribute name="reserveOrderEnumId" type="String" mode="IN" optional="true"/> <attribute name="sequenceId" type="Long" mode="IN" optional="true"/> <attribute name="serialNumber" type="String" mode="IN" optional="true"/> <attribute name="trackingNum" type="String" mode="IN" optional="true"/> <attribute name="originFacilityId" type="String" mode="IN" optional="true"/> <attribute name="quantityNotReserved" type="BigDecimal" mode="IN" optional="true"/> <attribute name="promisedDatetime" type="Timestamp" mode="IN" optional="false"/> <attribute name="shipmentPackageSeqId" type="String" mode="IN" optional="true"/> </service> <service name="setShipmentStatusPackedAndShipped" engine="simple" location="component://product/script/org/ofbiz/shipment/shipment/ShipmentServices.xml" invoke="setShipmentStatusPackedAndShipped" auth="true"> <description>Move a shipment into Packed status and then to Shipped status</description> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> </service> <service name="sendShipmentCompleteNotification" engine="java" require-new-transaction="true" max-retry="3" location="org.ofbiz.shipment.shipment.ShipmentServices" invoke="sendShipmentCompleteNotification" auth="true"> <description>Send a notification on Shipment Complete</description> <attribute name="shipmentId" type="String" mode="IN" optional="false"/> <attribute name="sendTo" type="String" mode="IN" optional="true"/> <attribute name="screenUri" type="String" mode="IN" optional="true"/> <attribute name="comments" type="String" mode="IN" optional="true"/> <attribute name="body" type="String" mode="OUT" optional="true"/> <attribute name="subject" type="String" mode="OUT" optional="true"/> <attribute name="orderId" type="String" mode="OUT" optional="true"/> <attribute name="messageWrapper" type="org.ofbiz.service.mail.MimeMessageWrapper" mode="OUT" optional="true"/> <attribute name="communicationEventId" type="String" mode="OUT" optional="true"/> </service> <service name="updateIssuanceShipmentAndPoOnReceiveInventory" engine="simple" location="component://product/script/org/ofbiz/shipment/receipt/ShipmentReceiptServices.xml" invoke="updateIssuanceShipmentAndPoOnReceiveInventory"> <description>Update issuance, shipment and order items if quantity received is higher than quantity on purchase order</description> <attribute name="orderId" type="String" mode="IN" optional="false"/> <attribute name="orderItemSeqId" type="String" mode="IN" optional="false"/> <attribute name="quantityAccepted" type="BigDecimal" mode="IN" optional="false"/> <attribute name="shipmentId" type="String" mode="IN" optional="true"/> <attribute name="shipmentItemSeqId" type="String" mode="IN" optional="true"/> <attribute name="unitCost" type="String" mode="IN" optional="true"/> <attribute name="orderCurrencyUnitPrice" type="String" mode="IN" optional="true"/> </service> </services> |