ecl-logo Documentation

OrderSamples

OrderSamples[Objects,Amounts]Transactions

generates a new order transaction to purchase the specified quantity of a given object.

Details

  • Placing an order for a given product or a model sample creates a transaction order to track its status through when the ordered item is received.
  • Input
    Output
    Order Options
    Shipment Options
    General Options
    Messages
  • AmountUnitThe specified amount: `1` in the following samples: `2` is not compatible with the associated products. Please check the amount input and sample's products, and place another order.
    DeprecatedThe products `1` have been deprecated and cannot be ordered.
    InvalidProductThe product(s): `1` is missing required information for placing an order on it. Please check ValidObjectQ with Verbose->Failures on the product(s).
    NotForSaleThe following products or the products of the samples: `1` are not for sale and cannot be ordered. Please check to see if there is another product listing matching your model that is for sale, or consider generating a new product listing for the model.
    NoValidProductsThe models `1` have no products that can be ordered, as those models are either missing product information or their products have been marked as Deprecated. Please create new products for these models so that we may place this order for you.
    OrderMustBeInternalBecause the Emerald Cloud Lab is a Supplier of one or more of the requested Models or Products, InternalOrder must be set to True.
    SyncPermissionDeniedYou must be a Developer in the public environment to use the SyncOrders option.

Examples

Basic Examples  (4)

Place an order for a specified model item with the desired quantity:

Place an order for a specified model sample with the desired amount:

Place an order for a specified quantity of several different products:

Place an order for a specified quantity of the given product (the total received samples will be the specified Quantity multiplied by NumberOfItems specified in the product):

Additional Examples  (3)

Place an order for several model samples:

Sending OrderSamples an empty list will return an empty list:

When InternalOrder -> False, duplicate models will be merged by totalling their requested amounts:

Options  (17)

Autogenerated  (1)

If Autogenerated is True, indicate that the order was generated automatically and that Creator is set to Null:

ContainerOut  (4)

Specify that some of the samples should be transferred to a different container upon arrival (external order):

Specify that some of the samples should be transferred to a different container upon arrival (internal order):

Specify that the samples should be transferred to a different container upon arrival (external order):

Specify that the samples should be transferred to a different container upon arrival (internal order):

Creator  (1)

If Creator is specified, indicate the creator in the order:

DependentProtocol  (1)

Specify that a protocol depends on the item being ordered to begin or continue execution:

DependentResource  (1)

Specify that a resource depends on the item being ordered to be fulfilled:

Destination  (1)

Specify the delivery site for the transaction order:

InternalOrder  (1)

If InternalOrder sets to True and the products are stocked on site at ECL, the products will be directly purchased from ECL's in house inventory:

Output  (2)

Returns the resolved options:

Returns the tests:

ReceivingTolerance  (1)

Specify the allowable difference between received amount and expected amount for any ordered samples:

ShippedRack  (2)

When a product is shipped with a rack, specify the rack model:

When a product requiring a rack to stand is shipped, automatically check if there is a rack on site that can hold it even when ShippedRack is Null:

ShippingSpeed  (1)

Set ShippingSpeed->1 Day to indicate the order should be shipped as soon as possible:

ShipToUser  (1)

Specify the products or samples that will send to your work location after received by ECL:

Messages  (22)

AmountUnit  (1)

Return an error if the specified amount does not match the unit specified in model sample's products:

ContainerOutInconsistent  (2)

If a different ContainerOut is specified for the same product, fails (model case, external order):

If a different ContainerOut is specified for the same product, fails (product case):

ContainerOutNotValidated  (3)

Give a warning if it cannot be determined whether the specified container out is large enough to hold the sample (model input):

Give a warning if it cannot be determined whether the specified container out is large enough to hold the sample (model input, internal order):

Give a warning if it cannot be determined whether the specified container out is large enough to hold the sample (product input):

Deprecated  (1)

Throws an error if any one of the products is marked as Deprecated:

IncompatibleProvidedRackModel  (1)

When the ShippedRack is not capable of supporting the container in which the product arrives (or if the ordered item is a container), an error is shown indicating incompatability:

InputLengthMismatch  (2)

If the length of destination is different from the input length, return an error:

Throws an error if the input lists are not the same length:

InvalidProduct  (1)

If the product doesn't pass ValidObjectQ, return an error:

NoCompatibleRack  (1)

If there is no Model[Container, Rack] in the database that can hold the recieved container upright based on its Footprint and Dimensions, return an error:

NotForSale  (2)

Orders can not be placed for models whose product is not for sale:

Throws an error if any one of the products is marked as NotForSale:

NoValidProducts  (1)

Orders can not be placed for models that only have deprecated products:

OptionNotRequired  (3)

If ContainerOut is specified for an item, give a message and fail (model input):

If ContainerOut is specified for an item, give a message and fail (model input, internal order):

If ContainerOut is specified for an item, give a message and fail (product input):

OrderMustBeInternal  (1)

If Emerald is the Supplier of the Product, InternalOrder MUST be True:

VolumeExceedsContainerOut  (3)

If ContainerOut is too small to hold the sample volume, give a message and fail (external order, model input):

If ContainerOut is too small to hold the sample volume, give a message and fail (model input, internal order):

If ContainerOut is too small to hold the sample volume, give a message and fail (product input):

Last modified on Sat 12 Aug 2023 12:40:28