Skip to main content

Package Command Parameters

sync_remote_order_status​

This parameter is used for sync package status with Omnitron.

Usage​

{
  "sync_remote_order_status": true
}

Available Commands List​

  • CompletePackingCommand
  • CompletePackingWithoutShipmentCommand
  • DeAllocatePackageReservationsCommand
  • PackagePackedForRefundCommand
  • PackageStateTransitionCommand
  • ReadyForPickupCommand
  • SelfServicePackageDeliveryCommand
  • ShipThePackageAdvancedCommand
  • ShipThePackageBasicCommand
  • ShipThePackageCommand
  • UpdatePackageShipmentStatusCommand
  • UpdateShipmentInfoOfThePackageCommand

remote_bill_fulfillment_call​

This parameter is used for remote bill calls when running the command. Using this parameter updates bill information based on the service associated with the package order source.

Usage​

{
    "remote_bill_fulfillment_call": true
}

Available Commands List​

  • CompletePackingCommand
  • CompletePackingWithoutShipmentCommand
  • ChannelBasedCompletePackingCommand

remote_invoice_call​

This parameter is used for making remote invoice calls when running a command. Using this parameter will update invoice information with the service specified in the configuration.

Usage​

{
    "remote_invoice_call": {
        "auth": { #required
            "request_type": "anonymous"
        },
        "timeouts": { #required
            "read": 10, # Default
            "connect": 60 # Default
        }, # required
        "remote_url": "https://url-for-invoice-service/"
    }
}

Generating Invoice Number and Invoice URL​

    {
            ...
            "generate_invoice_number": true,
            "generate_invoice_url": true
        }
    }

Auth Parameters​

Anonymous:

{
        ...
        "auth": {
            "request_type": "anonymous"
        }
}

Basic authentication:

{
        ...
        "auth": {
            "request_type": "basic_auth",
            "username":"username",
            "password":"password"
        }
}

Token authentication:

{
        ...
        "auth": {
            "request_type": "token",
            "token": "token",
            "token_prefix": "Bearer" # Default
        }
}

Available Commands List​

  • CompletePackingCommand
  • CompletePackingWithoutShipmentCommand
  • ChannelBasedCompletePackingCommand
  • ShipThePackageAdvancedCommand
  • UpdateInvoiceOfThePackageCommand

update_remote_orderitem_invoice​

When using the remote invoice call feature, you can choose not to synchronize invoice information with Omnitron by setting this parameter to false. The default behavior is to synchronize (true).

Usage​

{
    "update_remote_orderitem_invoice": false
}

Available Commands List​

  • ChannelBasedCompletePackagingCommand
  • CompletePackagingCommand
  • CompletePackagingWithoutShipmentCommand
  • ShipThePackageAdvancedCommand
  • ShipThePackageCommand
  • UpdateInvoiceOfThePackageCommand

deallocate_reservations​

When running the command, to keep allocated reservations, set this parameter to false. By default, it's set to true, which will deallocate reservations.

Usage​

{
    "deallocate_reservations": false
}

Available Commands List​

  • AssignPackageItemsManuallyCommand
  • CancelTransferOrderRenewPackageCommand
  • ChannelBasedCompletePackagingCommand
  • CompletePackagingCommand
  • CompletePackagingWithoutShipmentCommand
  • DeAllocatePackageReservationsCommand
  • DetectedOutOfStockItemCommand
  • PackagePackedForRefundCommand
  • ReadyForPickupCommand
  • RefusePackageCommand
  • ReportMissingItemCommand
  • SelfServicePackageDeliveryCommand

create_shipment​

When running the command, to skip creating a shipment, set this parameter to false. By default, it's set to true, which will automatically create a shipment.

Usage​

{
    "create_shipment": false
}

Available Commands List​

  • ChannelBasedCompletePackagingCommand
  • CompletePackagingCommand
  • PackageStateTransitionCommand